Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientExtensions

Extension methods for fm.websync.client instances.

Hierarchy

  • ClientExtensions

Index

Properties

Methods

Properties

Static Private __fmicelinkwebsync4ClientExtensionsInitialized

__fmicelinkwebsync4ClientExtensionsInitialized: boolean = false
internal

Static Private fm_icelink_websync4_ClientExtensions___lock

fm_icelink_websync4_ClientExtensions___lock: Object
internal

Static fm_icelink_websync4_ClientExtensions__retriable

fm_icelink_websync4_ClientExtensions__retriable: string
internal

Methods

getTypeString

  • getTypeString(): string

  • Returns string

Static Private acceptAnswer

  • acceptAnswer(connection: Connection, remoteDescription: SessionDescription): void
  • internal

    Parameters

    • connection: Connection
    • remoteDescription: SessionDescription

    Returns void

Static Private acceptOfferCreateAnswerAndSend

  • acceptOfferCreateAnswerAndSend(connection: Connection, client: Client, remoteDescription: SessionDescription, userId: string, channel: string, competingOffer: boolean, boundRecords: Hash<string, Record>, state: State): void
  • internal

    Parameters

    • connection: Connection
    • client: Client
    • remoteDescription: SessionDescription
    • userId: string
    • channel: string
    • competingOffer: boolean
    • boundRecords: Hash<string, Record>
    • state: State

    Returns void

Static Private createAndSendOffer

  • createAndSendOffer(connection: Connection, client: Client, channel: string, userId: string, promise: Promise<SessionDescription>): Promise<SessionDescription>
  • createAndSendOffer(connection: Connection, client: Client, channel: string, userId: string): Promise<SessionDescription>
  • internal

    Parameters

    • connection: Connection
    • client: Client
    • channel: string
    • userId: string
    • promise: Promise<SessionDescription>

    Returns Promise<SessionDescription>

  • internal

    Parameters

    • connection: Connection
    • client: Client
    • channel: string
    • userId: string

    Returns Promise<SessionDescription>

Static Private createNewConnectionAndSend

  • createNewConnectionAndSend(userId: string, boundRecords: Hash<string, Record>, state: State, remoteDescription: SessionDescription, client: Client, channel: string): void
  • internal

    Parameters

    • userId: string
    • boundRecords: Hash<string, Record>
    • state: State
    • remoteDescription: SessionDescription
    • client: Client
    • channel: string

    Returns void

Static Private doJoinConference

  • doJoinConference(client: Client, args: JoinConferenceArgs, state: State): Client
  • internal

    Parameters

    • client: Client
    • args: JoinConferenceArgs
    • state: State

    Returns Client

Static Private doLeaveConference

  • doLeaveConference(client: Client, args: LeaveConferenceArgs, state: State): Client
  • internal

    Parameters

    • client: Client
    • args: LeaveConferenceArgs
    • state: State

    Returns Client

Static Private doRenegotiateConference

  • doRenegotiateConference(client: Client, state: State, promise: Promise<Object>, connections: Connection[]): void
  • internal

    Parameters

    • client: Client
    • state: State
    • promise: Promise<Object>
    • connections: Connection[]

    Returns void

Static fmicelinkwebsync4ClientExtensionsInitialize

  • fmicelinkwebsync4ClientExtensionsInitialize(): void
  • internal

    Returns void

Static Private getAndCacheConnection

  • getAndCacheConnection(remoteClient: PeerClient): Connection
  • internal

    Parameters

    • remoteClient: PeerClient

    Returns Connection

Static Private getInstanceChannel

  • getInstanceChannel(conferenceChannel: string, clientId: string): string
  • internal

    Parameters

    • conferenceChannel: string
    • clientId: string

    Returns string

Static joinConference

  • joinConference(client: Client, args: JoinConferenceArgs): Client
  • Joins an IceLink conference.

    Parameters

    • client: Client

      The WebSync client.

    • args: JoinConferenceArgs

      The arguments.

    Returns Client

    The WebSync client.

Static leaveConference

  • leaveConference(client: Client, args: LeaveConferenceArgs): Client
  • Leaves an IceLink conference.

    Parameters

    • client: Client

      The WebSync client.

    • args: LeaveConferenceArgs

      The arguments.

    Returns Client

    The WebSync client.

Static Private preparePendingRenegotiationPromise

  • preparePendingRenegotiationPromise(connection: Connection, client: Client, channel: string, individualPromises: Array<Future<SessionDescription>>, processed: number): void
  • internal

    Parameters

    • connection: Connection
    • client: Client
    • channel: string
    • individualPromises: Array<Future<SessionDescription>>
    • processed: number

    Returns void

Static Private processReadyForRenegotiation

  • processReadyForRenegotiation(connection: Connection): void
  • internal

    Parameters

    • connection: Connection

    Returns void

Static Private raiseJoinFailure

  • raiseJoinFailure(args: JoinConferenceArgs, e: BaseFailureArgs, conferenceChannel: string): void
  • internal

    Parameters

    • args: JoinConferenceArgs
    • e: BaseFailureArgs
    • conferenceChannel: string

    Returns void

Static Private raiseJoinReceive

  • raiseJoinReceive(args: JoinConferenceArgs, e: BaseReceiveArgs, channel: string, remoteUserId: string, remoteBoundRecords: Hash<string, Record>): void
  • internal

    Parameters

    • args: JoinConferenceArgs
    • e: BaseReceiveArgs
    • channel: string
    • remoteUserId: string
    • remoteBoundRecords: Hash<string, Record>

    Returns void

Static Private raiseJoinRemoteClient

  • raiseJoinRemoteClient(args: JoinConferenceArgs, remoteClient: PeerClient, userId: string): Connection
  • internal

    Parameters

    • args: JoinConferenceArgs
    • remoteClient: PeerClient
    • userId: string

    Returns Connection

Static Private raiseJoinSuccess

  • raiseJoinSuccess(args: JoinConferenceArgs, e: BaseSuccessArgs, conferenceChannel: string, users: ChatUser[]): void
  • internal

    Parameters

    • args: JoinConferenceArgs
    • e: BaseSuccessArgs
    • conferenceChannel: string
    • users: ChatUser[]

    Returns void

Static Private raiseLeaveFailure

  • raiseLeaveFailure(args: LeaveConferenceArgs, e: BaseFailureArgs, conferenceChannel: string): void
  • internal

    Parameters

    • args: LeaveConferenceArgs
    • e: BaseFailureArgs
    • conferenceChannel: string

    Returns void

Static Private raiseLeaveSuccess

  • raiseLeaveSuccess(args: LeaveConferenceArgs, e: BaseSuccessArgs, conferenceChannel: string): void
  • internal

    Parameters

    • args: LeaveConferenceArgs
    • e: BaseSuccessArgs
    • conferenceChannel: string

    Returns void

Static Private receiveRemoteCandidate

  • receiveRemoteCandidate(e: SubscribeReceiveArgs, state: State, userId: string, boundRecords: Hash<string, Record>): boolean
  • internal

    Parameters

    • e: SubscribeReceiveArgs
    • state: State
    • userId: string
    • boundRecords: Hash<string, Record>

    Returns boolean

Static Private receiveRemoteDescription

  • receiveRemoteDescription(e: SubscribeReceiveArgs, state: State, userId: string, boundRecords: Hash<string, Record>, client: Client, conferenceChannel: string): boolean
  • internal

    Parameters

    • e: SubscribeReceiveArgs
    • state: State
    • userId: string
    • boundRecords: Hash<string, Record>
    • client: Client
    • conferenceChannel: string

    Returns boolean

Static reconnectRemoteClient

  • reconnectRemoteClient(client: Client, remoteClient: PeerClient, failedConnection: Connection): void
  • Reconnects remote client.

    Parameters

    • client: Client

      The WebSync client.

    • remoteClient: PeerClient

      The remote client.

    • failedConnection: Connection

      Failed connection that requires reconnection.

    Returns void

Static renegotiate

  • renegotiate(client: Client, conferenceChannel: string, connection: Connection): Future<Object>
  • Commences session description renegotiation for the specified connection.

    Parameters

    • client: Client

      The WebSync client.

    • conferenceChannel: string

      Conference channel.

    • connection: Connection

      The connection on which to renegotiate.

    Returns Future<Object>

Static Private renegotiateConnection

  • renegotiateConnection(processed: number, client: Client, channel: string, promise: Promise<Object>, connections: Connection[], individualPromises: Array<Future<SessionDescription>>): void
  • internal

    Parameters

    • processed: number
    • client: Client
    • channel: string
    • promise: Promise<Object>
    • connections: Connection[]
    • individualPromises: Array<Future<SessionDescription>>

    Returns void

Static Private resolveNextConnection

  • resolveNextConnection(processed: number, client: Client, channel: string, promise: Promise<Object>, connections: Connection[], individualPromises: Array<Future<SessionDescription>>): void
  • internal

    Parameters

    • processed: number
    • client: Client
    • channel: string
    • promise: Promise<Object>
    • connections: Connection[]
    • individualPromises: Array<Future<SessionDescription>>

    Returns void

Static Private sendLocalCandidate

  • sendLocalCandidate(client: Client, conferenceChannel: string, userId: string, localCandidate: Candidate): void
  • internal

    Parameters

    • client: Client
    • conferenceChannel: string
    • userId: string
    • localCandidate: Candidate

    Returns void

Static Private sendLocalDescription

  • sendLocalDescription(client: Client, conferenceChannel: string, userId: string, localDescription: SessionDescription, promise: Promise<SessionDescription>): Future<SessionDescription>
  • internal

    Parameters

    • client: Client
    • conferenceChannel: string
    • userId: string
    • localDescription: SessionDescription
    • promise: Promise<SessionDescription>

    Returns Future<SessionDescription>

Static Private setRemoteDescription

  • setRemoteDescription(connection: Connection, remoteDescription: SessionDescription, client: Client, channel: string, userId: string): void
  • internal

    Parameters

    • connection: Connection
    • remoteDescription: SessionDescription
    • client: Client
    • channel: string
    • userId: string

    Returns void