Interface IClient

Hierarchy

IClient

Index

Methods

Methods

attendedTransfer

attendedTransfer(a: object, b: object): Promise<boolean>

- Defined in client.ts:81
Parameters
- a: object
- b: object
Returns Promise<boolean>

close

close(): Promise<void>

- Defined in client.ts:48
Returns Promise<void>

connect

connect(): Promise<boolean>

- Defined in client.ts:38
Returns Promise<boolean>

createPublisher

createPublisher(contact: string, options: PublisherOptions): Publisher

- Defined in client.ts:83
Parameters
- contact: string
- options: PublisherOptions
Returns Publisher

disconnect

disconnect(): Promise<void>

- Defined in client.ts:43
Returns Promise<void>

getSession

getSession(id: string): ISession

- Defined in client.ts:66
Parameters
- id: string
Returns ISession

getSessions

getSessions(): ISession[]

- Defined in client.ts:67
Returns ISession[]

invite

invite(uri: string): Promise<ISession>

- Defined in client.ts:61
Parameters
- uri: string
Returns Promise<ISession>

isConnected

isConnected(): boolean

- Defined in client.ts:50
Returns boolean

on

on(event: "invite", listener: function): this
on(event: "subscriptionNotify", listener: function): this
on(event: "sessionAdded", listener: function): this
on(event: "sessionRemoved", listener: function): this

- Defined in client.ts:107
Parameters
- event: "invite"
- listener: function
  - - (session: ISession): void
    - Parameters
      - session: ISession
      Returns void
Returns this
- Defined in client.ts:124
Parameters
- event: "subscriptionNotify"
- listener: function
  - - (contact: string, status: string): void
    - Parameters
      - contact: string
      - status: string
      Returns void
Returns this
- Defined in client.ts:130
Parameters
- event: "sessionAdded"
- listener: function
  - - (__namedParameters: object): void
    - Parameters
      - __namedParameters: object
      Returns void
Returns this
- Defined in client.ts:136
Parameters
- event: "sessionRemoved"
- listener: function
  - - (__namedParameters: object): void
    - Parameters
      - __namedParameters: object
      Returns void
Returns this

reconfigure

reconfigure(options: IClientOptions): Promise<void>

- Defined in client.ts:33
Parameters
- options: IClientOptions
Returns Promise<void>

subscribe

subscribe(uri: string): Promise<void>

- Defined in client.ts:63
Parameters
- uri: string
Returns Promise<void>

unsubscribe

unsubscribe(uri: string): void

- Defined in client.ts:64
Parameters
- uri: string
Returns void

Generated using TypeDoc