Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebsocketTask

Represents a WebsocketTask.

Hierarchy

  • WebsocketTask

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

filter

filter: string

WebsocketTask filter.

maxDataAgeSeconds

maxDataAgeSeconds: number

WebsocketTask maxDataAgeSeconds.

subscription

subscription: string

WebsocketTask subscription.

url

url: string

WebsocketTask url.

Methods

toJSON

  • toJSON(): {}

  • Converts this WebsocketTask to JSON.

    Returns {}

    JSON object

    • [k: string]: any

Static create

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): WebsocketTask

  • Decodes a WebsocketTask message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns WebsocketTask

    WebsocketTask

Static decodeDelimited

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

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns WebsocketTask

    WebsocketTask

Static encode

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

    Parameters

    • message: IWebsocketTask

      WebsocketTask message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IWebsocketTask

      WebsocketTask message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns WebsocketTask

    WebsocketTask

Static toObject

  • toObject(message: WebsocketTask, options?: IConversionOptions): {}

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

    Parameters

    • message: WebsocketTask

      WebsocketTask

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): null | string

  • Verifies a WebsocketTask message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc