Class PidfLo

Hierarchy

PidfLo

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new PidfLo(_entity?: string): <internal>.PidfLo

- Defined in node_modules/pidf-lo/dist/types/pidf.d.ts:69
Parameters
- Optional _entity: string
Returns <internal>.PidfLo

Properties

equals

equals: (pidfLo: <internal>.PidfLo) => boolean

Type declaration

- (pidfLo: <internal>.PidfLo): boolean
- Parameters
  - pidfLo: <internal>.PidfLo
  Returns boolean

locationTypes

locationTypes: LocationType[]

toXML

toXML: () => <internal>.XMLDocument

Type declaration

- (): <internal>.XMLDocument
- Returns <internal>.XMLDocument

toXMLString

toXMLString: () => string

Type declaration

- (): string
- Returns string

Static fromSimpleLocation

fromSimpleLocation: (location: SimpleLocation, originSipUri?: string) => undefined | <internal>.PidfLo

Type declaration

- (location: SimpleLocation, originSipUri?: string): undefined | <internal>.PidfLo
- Parameters
  - location: SimpleLocation
  - Optional originSipUri: string
  Returns undefined | <internal>.PidfLo

Static fromXML

fromXML: (xml: string) => undefined | <internal>.PidfLo

Type declaration

- (xml: string): undefined | <internal>.PidfLo
- Parameters
  - xml: string
  Returns undefined | <internal>.PidfLo

Accessors

entity

get entity(): undefined | string
set entity(value: undefined | string): void

- Defined in node_modules/pidf-lo/dist/types/pidf.d.ts:74
https://tools.ietf.org/html/rfc4479#section-3.1

Returns undefined | string
- Defined in node_modules/pidf-lo/dist/types/pidf.d.ts:73
https://tools.ietf.org/html/rfc4479#section-3.1

Parameters
- value: undefined | string
Returns void

simple

get simple(): undefined | SimpleLocation

- Defined in node_modules/pidf-lo/dist/types/pidf.d.ts:83
Retrieve a SimpleLocation object for easy interaction with PidfLo locations
Keep in mind that this might not necessarily represent all information that's available in PidfLo!

Returns undefined | SimpleLocation

Generated using TypeDoc