Represents a WebdPayload.

Hierarchy

  • WebdPayload

Implements

Constructors

Properties

documentTypes: string

WebdPayload documentTypes.

features: Uint8Array

WebdPayload features.

supportsDocumentMessages: boolean

WebdPayload supportsDocumentMessages.

supportsE2EAudio: boolean

WebdPayload supportsE2EAudio.

supportsE2EDocument: boolean

WebdPayload supportsE2EDocument.

supportsE2EImage: boolean

WebdPayload supportsE2EImage.

supportsE2EVideo: boolean

WebdPayload supportsE2EVideo.

supportsMediaRetry: boolean

WebdPayload supportsMediaRetry.

supportsStarredMessages: boolean

WebdPayload supportsStarredMessages.

supportsUrlMessages: boolean

WebdPayload supportsUrlMessages.

usesParticipantInKey: boolean

WebdPayload usesParticipantInKey.

Methods

  • Converts this WebdPayload to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a WebdPayload message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns WebdPayload

    WebdPayload

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes a WebdPayload message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns WebdPayload

    WebdPayload

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified WebdPayload message. Does not implicitly verify messages.

    Parameters

    • message: IWebdPayload

      WebdPayload message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified WebdPayload message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IWebdPayload

      WebdPayload message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Creates a WebdPayload message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns WebdPayload

    WebdPayload

  • Creates a plain object from a WebdPayload message. Also converts values to other types if specified.

    Parameters

    • message: WebdPayload

      WebdPayload

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a WebdPayload message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc