Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JoinConferenceArgs

Arguments for a client joining an IceLink conference.

Hierarchy

  • BaseInputArgs
    • JoinConferenceArgs

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the fm.icelink.websync4.joinConferenceArgs class.

    Returns JoinConferenceArgs

  • Initializes a new instance of the fm.icelink.websync4.joinConferenceArgs class.

    Parameters

    • conferenceChannel: string

      The conference channel.

    Returns JoinConferenceArgs

Properties

Private _conferenceChannel

_conferenceChannel: string
internal

Private _onFailure

_onFailure: IAction1<JoinConferenceFailureArgs>
internal

Private _onReceive

_onReceive: IAction1<JoinConferenceReceiveArgs>
internal

Private _onRemoteClient

_onRemoteClient: IFunction1<PeerClient, Connection>
internal

Private _onSuccess

_onSuccess: IAction1<JoinConferenceSuccessArgs>
internal

Private _unlinkExistingOnUserJoin

_unlinkExistingOnUserJoin: boolean
internal

Private _unlinkOnUserLeave

_unlinkOnUserLeave: boolean
internal

Methods

copyExtensions

  • copyExtensions(extensible: extensible): void

  • Parameters

    • extensible: extensible

    Returns void

getConferenceChannel

  • getConferenceChannel(): string
  • Gets the conference channel.

    Returns string

getDynamicProperties

  • getDynamicProperties(): any

  • Returns any

getDynamicValue

  • getDynamicValue(key: string): any

  • Parameters

    • key: string

    Returns any

getExtensionCount

  • getExtensionCount(): number

  • Returns number

getExtensionNames

  • getExtensionNames(): string[]

  • Returns string[]

getExtensionValueJson

  • getExtensionValueJson(name: string): string

  • Parameters

    • name: string

    Returns string

getExtensions

  • getExtensions(): any

  • Returns any

getIsRetry

  • getIsRetry(): any

  • Returns any

getMetaJson

  • getMetaJson(): any

  • Returns any

getOnFailure

  • getOnFailure(): IAction1<JoinConferenceFailureArgs>
  • Gets the callback to invoke if the request fails. See fm.icelink.websync4.joinConferenceFailureArgs for callback argument details.

    Returns IAction1<JoinConferenceFailureArgs>

getOnReceive

  • getOnReceive(): IAction1<JoinConferenceReceiveArgs>
  • Gets the callback to invoke when data is received on the channel. See fm.icelink.websync4.joinConferenceReceiveArgs for callback argument details.

    Returns IAction1<JoinConferenceReceiveArgs>

getOnRemoteClient

  • getOnRemoteClient(): IFunction1<PeerClient, Connection>
  • Gets the callback to invoke when a new remote client needs a connection.

    Returns IFunction1<PeerClient, Connection>

getOnSuccess

  • getOnSuccess(): IAction1<JoinConferenceSuccessArgs>
  • Gets the callback to invoke if the request succeeds. See fm.icelink.websync4.joinConferenceSuccessArgs for callback argument details.

    Returns IAction1<JoinConferenceSuccessArgs>

getRequestTimeout

  • getRequestTimeout(): any

  • Returns any

getRequestUrl

  • getRequestUrl(): any

  • Returns any

getSynchronous

  • getSynchronous(): any

  • Returns any

getTypeString

  • getTypeString(): string

  • Returns string

getUnlinkExistingOnUserJoin

  • getUnlinkExistingOnUserJoin(): boolean
  • Gets a value indicating whether this endpoint should drop existing links in favour of new ones when remote peers join the channel. Defaults to true.

    Returns boolean

getUnlinkOnUserLeave

  • getUnlinkOnUserLeave(): boolean
  • Gets a value indicating whether this endpoint should initiate an unlink when remote peers leave the channel. Defaults to true.

    Returns boolean

setConferenceChannel

  • setConferenceChannel(value: string): void
  • Sets the conference channel.

    Parameters

    • value: string

    Returns void

setDynamicProperties

  • setDynamicProperties(value: any): void

  • Parameters

    • value: any

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: any): void

  • Parameters

    • key: string
    • value: any

    Returns void

setExtensionValueJson

  • setExtensionValueJson(name: string, valueJson: string): void
  • setExtensionValueJson(name: string, valueJson: string, validate: boolean): void

  • Parameters

    • name: string
    • valueJson: string

    Returns void

  • Parameters

    • name: string
    • valueJson: string
    • validate: boolean

    Returns void

setExtensions

  • setExtensions(value: any): void

  • Parameters

    • value: any

    Returns void

setIsRetry

  • setIsRetry(value: any): void

  • Parameters

    • value: any

    Returns void

setMetaJson

  • setMetaJson(value: any): void

  • Parameters

    • value: any

    Returns void

setOnFailure

  • setOnFailure(value: IAction1<JoinConferenceFailureArgs>): void
  • Sets the callback to invoke if the request fails. See fm.icelink.websync4.joinConferenceFailureArgs for callback argument details.

    Parameters

    • value: IAction1<JoinConferenceFailureArgs>

    Returns void

setOnReceive

  • setOnReceive(value: IAction1<JoinConferenceReceiveArgs>): void
  • Sets the callback to invoke when data is received on the channel. See fm.icelink.websync4.joinConferenceReceiveArgs for callback argument details.

    Parameters

    • value: IAction1<JoinConferenceReceiveArgs>

    Returns void

setOnRemoteClient

  • setOnRemoteClient(value: IFunction1<PeerClient, Connection>): void
  • Sets the callback to invoke when a new remote client needs a connection.

    Parameters

    • value: IFunction1<PeerClient, Connection>

    Returns void

setOnSuccess

  • setOnSuccess(value: IAction1<JoinConferenceSuccessArgs>): void
  • Sets the callback to invoke if the request succeeds. See fm.icelink.websync4.joinConferenceSuccessArgs for callback argument details.

    Parameters

    • value: IAction1<JoinConferenceSuccessArgs>

    Returns void

setRequestTimeout

  • setRequestTimeout(value: any): void

  • Parameters

    • value: any

    Returns void

setRequestUrl

  • setRequestUrl(value: any): void

  • Parameters

    • value: any

    Returns void

setSynchronous

  • setSynchronous(value: any): void

  • Parameters

    • value: any

    Returns void

setUnlinkExistingOnUserJoin

  • setUnlinkExistingOnUserJoin(value: boolean): void
  • Sets a value indicating whether this endpoint should drop existing links in favour of new ones when remote peers join the channel. Defaults to true.

    Parameters

    • value: boolean

    Returns void

setUnlinkOnUserLeave

  • setUnlinkOnUserLeave(value: boolean): void
  • Sets a value indicating whether this endpoint should initiate an unlink when remote peers leave the channel. Defaults to true.

    Parameters

    • value: boolean

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean

  • Parameters

    • key: string

    Returns boolean