Class MuteModel

constructor

• new MuteModel(
      proterties?: ModelPropertiesContructor<MuteModel>,
      options?: ModelOptions,
  ): MuteModel

• Parameters

  • Optionalproterties: ModelPropertiesContructor<MuteModel>
  • Optionaloptions: ModelOptions

  Returns MuteModel

OptionalallowedIds

Optionalcollection

idClass

Optionalparent

proxyName

Static OptionalallowedIds

Static OptionalidClass

StaticProxy

addChild

• addChild(id: Stringable, context: { [key: string]: any }): void

• Parameters

  • id: Stringable
  • context: { [key: string]: any }

  Returns void

bind

• bind(eventName: Event, listener: Listener, context?: any): this

• Alias of on

  Parameters

  • eventName: Event
  • listener: Listener
  • Optionalcontext: any

  Returns this

  Alias

  on

canMute

• canMute(): boolean

• Returns boolean

clear

• clear(): void

• Returns void

decObservers

• decObservers(): void

• Returns void

delete

• delete(): void

• Returns void

emit

• emit(eventName: Event, ...args: any[]): this

• Alias of trigger

  Parameters

  • eventName: Event
  • ...args: any[]

  Returns this

  Alias

  trigger

get

• get<T extends keyof MuteModel>(attr: T): MuteModel[T]

• Type Parameters

  • T extends keyof MuteModel

  Parameters

  • attr: T

  Returns MuteModel[T]

getCollection

• getCollection(): MuteCollection

• Returns MuteCollection

getDefault

• getDefault<T extends keyof MuteModel>(attr: T): any

• Type Parameters

  • T extends keyof MuteModel

  Parameters

  • attr: T

  Returns any

hasObservers

• hasObservers(): boolean

• Returns boolean

hasUnfiredChanges

• hasUnfiredChanges(): boolean

• Returns boolean

incObservers

• incObservers(e?: boolean): void

• Parameters

  • Optionale: boolean

  Returns void

initialize

• initialize(): void

• Returns void

isListening

• isListening(eventName: Event): boolean

• Parameters

  • eventName: Event

  Returns boolean

listenTo

• listenTo(context: any, eventName: Event, listener?: Listener): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.

  Returns this

listenToAndRun

• listenToAndRun(context: any, eventName: Event, listener?: Listener): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.

  Returns this

listenToOnce

• listenToOnce(context: any, eventName: Event, listener?: Listener): this

• Parameters

  • context: any

    The value of this provided for the call to listener
  • eventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.

  Returns this

mute

• mute(
      args: {
          expiration: number;
          isAutoMuted?: boolean;
          sendDevice?: boolean;
      },
  ): Promise<number>

• Parameters

  • args: { expiration: number; isAutoMuted?: boolean; sendDevice?: boolean }

  Returns Promise<number>

off

• off(eventName?: Event, listener?: Listener, context?: any): this

• Removes the specified listener from the listener array for the event named eventName.

  Parameters

  • OptionaleventName: Event

    The name of the event.
  • Optionallistener: Listener

    The callback function.
  • Optionalcontext: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

on

• on(eventName: Event, listener: Listener, context?: any): this

• Adds the listener function to the end of the listeners array for the event named eventName.

  Parameters

  • eventName: Event

    The name of the event.
  • listener: Listener

    The callback function.
  • Optionalcontext: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

once

• once(eventName: Event, listener: Listener, context?: any): this

• Adds a one-time listener function for the event named eventName.

  Parameters

  • eventName: Event

    The name of the event.
  • listener: Listener

    The callback function.
  • Optionalcontext: any

    The value of this provided for the call to listener

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

removeAllListeners

• removeAllListeners(): this

• Removes all listeners.

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

removeListener

• removeListener(eventName?: Event, listener?: Listener, context?: any): this

• Alias of off

  Parameters

  • OptionaleventName: Event
  • Optionallistener: Listener
  • Optionalcontext: any

  Returns this

  Alias

  off

reset

• reset(): void

• Returns void

set

• set(...args: any): any

• Parameters

  • ...args: any

  Returns any

setMute

• setMute(expiration?: number, isAutoMuted?: boolean, sendDevice?: boolean): any

• Parameters

  • Optionalexpiration: number
  • OptionalisAutoMuted: boolean
  • OptionalsendDevice: boolean

  Returns any

stopListening

• stopListening(context?: any, eventName?: Event, listener?: Listener): this

• Parameters

  • Optionalcontext: any
  • OptionaleventName: Event
  • Optionallistener: Listener

  Returns this

trigger

• trigger(eventName: Event, ...args: any[]): this

• Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

  Parameters

  • eventName: Event
  • ...args: any[]

  Returns this

  Returns a reference to the EventEmitter, so that calls can be chained.

unbind

• unbind(eventName?: Event, listener?: Listener, context?: any): this

• Alias of off

  Parameters

  • OptionaleventName: Event
  • Optionallistener: Listener
  • Optionalcontext: any

  Returns this

  Alias

  off

unmute

• unmute(args: { sendDevice?: boolean }): Promise<void>

• Parameters

  • args: { sendDevice?: boolean }

  Returns Promise<void>

unset

• unset(ids: Stringable | Stringable[], t?: any): void

• Parameters

  • ids: Stringable | Stringable[]
  • Optionalt: any

  Returns void

StaticisIdType

• isIdType(e: any): boolean

• Parameters

  • e: any

  Returns boolean