Class MuteModel

constructor

• new MuteModel(proterties?, options?): MuteModel

• Parameters

  • Optional proterties: ModelPropertiesContructor<MuteModel>
  • Optional options: ModelOptions

  Returns MuteModel

Optional allowedIds

Readonly attributes

Optional collection

expiration

id

idClass

Readonly isMuted

Readonly isState

Readonly mirrorMask

Optional parent

Optional promises

proxyName

Optional stale

Static Proxy

Static Optional allowedIds

Static Optional idClass

addChild

• addChild(id, context): void

• Parameters

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

    • [key: string]: any

  Returns void

bind

• bind(eventName, listener, context?): this

• Alias of on

  Parameters

  • eventName: Event
  • listener: Listener
  • Optional context: 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, ...args): this

• Alias of trigger

  Parameters

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

  Returns this

  Alias

  trigger

get

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

• Type Parameters

  • T extends keyof MuteModel

  Parameters

  • attr: T

  Returns MuteModel[T]

getCollection

• getCollection(): MuteCollection

• Returns MuteCollection

getDefault

• getDefault<T>(attr): 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?): void

• Parameters

  • Optional e: boolean

  Returns void

initialize

• initialize(): void

• Returns void

isListening

• isListening(eventName): boolean

• Parameters

  • eventName: Event

  Returns boolean

listenTo

• listenTo(context, eventName, listener?): this

• Parameters

  • context: any

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

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

listenToAndRun

• listenToAndRun(context, eventName, listener?): this

• Parameters

  • context: any

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

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

listenToOnce

• listenToOnce(context, eventName, listener?): this

• Parameters

  • context: any

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

    The name of the event.
  • Optional listener: Listener

    The callback function.

  Returns this

mute

• mute(args): Promise<number>

• Parameters

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

    • expiration: number

    • Optional isAutoMuted?: boolean

    • Optional sendDevice?: boolean

  Returns Promise<number>

off

• off(eventName?, listener?, context?): this

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

  Parameters

  • Optional eventName: Event

    The name of the event.
  • Optional listener: Listener

    The callback function.
  • Optional context: 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, listener, context?): 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.
  • Optional context: 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, listener, context?): 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.
  • Optional context: 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?, listener?, context?): this

• Alias of off

  Parameters

  • Optional eventName: Event
  • Optional listener: Listener
  • Optional context: any

  Returns this

  Alias

  off

reset

• reset(): void

• Returns void

serialize

• serialize(): Props

• Returns Props

set

• set(...args): any

• Parameters

  • Rest ...args: any

  Returns any

setMute

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

• Parameters

  • Optional expiration: number
  • Optional isAutoMuted: boolean
  • Optional sendDevice: boolean

  Returns any

stopListening

• stopListening(context?, eventName?, listener?): this

• Parameters

  • Optional context: any
  • Optional eventName: Event
  • Optional listener: Listener

  Returns this

toJSON

• toJSON(): Props

• Returns Props

trigger

• trigger(eventName, ...args): 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
  • Rest ...args: any[]

  Returns this

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

unbind

• unbind(eventName?, listener?, context?): this

• Alias of off

  Parameters

  • Optional eventName: Event
  • Optional listener: Listener
  • Optional context: any

  Returns this

  Alias

  off

unmute

• unmute(args): Promise<void>

• Parameters

  • args: {
        sendDevice?: boolean;
    }

    • Optional sendDevice?: boolean

  Returns Promise<void>

unset

• unset(ids, t?): void

• Parameters

  • ids: Stringable | Stringable[]
  • Optional t: any

  Returns void

Static isIdType

• isIdType(e): boolean

• Parameters

  • e: any

  Returns boolean