Class Store

Hierarchy

Store

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Store(originSipUri: string, logger: Logger, customSipHeaders?: CustomSipHeaders): Store

- Defined in src/models/store.ts:31
Parameters
- originSipUri: string
- logger: Logger
- Optional customSipHeaders: CustomSipHeaders
Returns Store

Properties

Readonly conversations

conversations: Conversation[] = []

Optional Readonly customSipHeaders

customSipHeaders?: CustomSipHeaders

Readonly logger

logger: Logger

Readonly originSipUri

originSipUri: string

Methods

addHeartbeatIntervalListener

addHeartbeatIntervalListener(callback: (interval: number) => unknown): void

- Defined in src/models/store.ts:68
Parameters
- callback: (interval: number) => unknown
  - - (interval: number): unknown
    - Parameters
      - interval: number
      Returns unknown
Returns void

getHeartbeatInterval

getHeartbeatInterval(): number

- Defined in src/models/store.ts:45
Returns number

getLocation

getLocation(): undefined | <internal>.PidfLo

- Defined in src/models/store.ts:43
Returns undefined | <internal>.PidfLo

getVCard

getVCard(): undefined | VCard

- Defined in src/models/store.ts:42
Returns undefined | VCard

removeHeartbeatIntervalListener

removeHeartbeatIntervalListener(callback: (interval: number) => unknown): void

- Defined in src/models/store.ts:72
Parameters
- callback: (interval: number) => unknown
  - - (interval: number): unknown
    - Parameters
      - interval: number
      Returns unknown
Returns void

setHeartbeatInterval

setHeartbeatInterval(interval?: number): void

- Defined in src/models/store.ts:55
Sets the update interval for heartbeat messages that are sent automatically

Parameters
- interval: number = defaultHeartbeatInterval
  
  New interval to be used (in milliseconds)
  Values between (including) 0 and 20000 are allowed only (due to ETSI spcification requirements)!
  If value 0 is specified, automatic heartbeats will be disabled.
  If no value is specified, a default interval of 15000 milliseconds will be applied.
Returns void

updateLocation

updateLocation(location?: <internal>.PidfLo): void

- Defined in src/models/store.ts:38
Parameters
- Optional location: <internal>.PidfLo
Returns void

updateVCard

updateVCard(vcard?: VCard): undefined | VCard

- Defined in src/models/store.ts:37
Parameters
- Optional vcard: VCard
Returns undefined | VCard

Generated using TypeDoc