Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LeaveConferenceArgs

Arguments for a client leaving an IceLink conference.

Hierarchy

  • BaseInputArgs
    • LeaveConferenceArgs

Index

Constructors

Properties

Methods

Constructors

constructor

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

    Returns LeaveConferenceArgs

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

    Parameters

    • conferenceChannel: string

      The conference ID.

    Returns LeaveConferenceArgs

Properties

Private _conferenceChannel

_conferenceChannel: string
internal

Private _onFailure

_onFailure: IAction1<LeaveConferenceFailureArgs>
internal

Private _onSuccess

_onSuccess: IAction1<LeaveConferenceSuccessArgs>
internal

Private _unlinkAllOnSuccess

_unlinkAllOnSuccess: 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<LeaveConferenceFailureArgs>
  • Gets the callback to invoke if the request fails.

    Returns IAction1<LeaveConferenceFailureArgs>

getOnSuccess

  • getOnSuccess(): IAction1<LeaveConferenceSuccessArgs>
  • Gets the callback to invoke if the request succeeds.

    Returns IAction1<LeaveConferenceSuccessArgs>

getRequestTimeout

  • getRequestTimeout(): any

  • Returns any

getRequestUrl

  • getRequestUrl(): any

  • Returns any

getSynchronous

  • getSynchronous(): any

  • Returns any

getTypeString

  • getTypeString(): string

  • Returns string

getUnlinkAllOnSuccess

  • getUnlinkAllOnSuccess(): boolean
  • Gets a value indicating whether this endpoint should initiate an unlink from everyone after leaving the channel successfully. 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<LeaveConferenceFailureArgs>): void
  • Sets the callback to invoke if the request fails.

    Parameters

    • value: IAction1<LeaveConferenceFailureArgs>

    Returns void

setOnSuccess

  • setOnSuccess(value: IAction1<LeaveConferenceSuccessArgs>): void
  • Sets the callback to invoke if the request succeeds.

    Parameters

    • value: IAction1<LeaveConferenceSuccessArgs>

    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

setUnlinkAllOnSuccess

  • setUnlinkAllOnSuccess(value: boolean): void
  • Sets a value indicating whether this endpoint should initiate an unlink from everyone after leaving the channel successfully. Defaults to true.

    Parameters

    • value: boolean

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean

  • Parameters

    • key: string

    Returns boolean