Skip to main content

Class: MediaNotifyMessage

Defined in: WAProto/index.d.ts:16533

Represents a MediaNotifyMessage.

Implements

Constructors

new MediaNotifyMessage()

new MediaNotifyMessage(properties?): MediaNotifyMessage

Defined in: WAProto/index.d.ts:16539

Constructs a new MediaNotifyMessage.

Parameters

properties?

IMediaNotifyMessage

Properties to set

Returns

MediaNotifyMessage

Properties

expressPathUrl?

optional expressPathUrl: null | string

Defined in: WAProto/index.d.ts:16542

MediaNotifyMessage expressPathUrl.

Implementation of

IMediaNotifyMessage.expressPathUrl


fileEncSha256?

optional fileEncSha256: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:16545

MediaNotifyMessage fileEncSha256.

Implementation of

IMediaNotifyMessage.fileEncSha256


fileLength?

optional fileLength: null | number | Long

Defined in: WAProto/index.d.ts:16548

MediaNotifyMessage fileLength.

Implementation of

IMediaNotifyMessage.fileLength

Methods

toJSON()

toJSON(): object

Defined in: WAProto/index.d.ts:16618

Converts this MediaNotifyMessage to JSON.

Returns

object

JSON object


create()

static create(properties?): MediaNotifyMessage

Defined in: WAProto/index.d.ts:16555

Creates a new MediaNotifyMessage instance using the specified properties.

Parameters

properties?

IMediaNotifyMessage

Properties to set

Returns

MediaNotifyMessage

MediaNotifyMessage instance


decode()

static decode(reader, length?): MediaNotifyMessage

Defined in: WAProto/index.d.ts:16581

Decodes a MediaNotifyMessage message from the specified reader or buffer.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?

number

Message length if known beforehand

Returns

MediaNotifyMessage

MediaNotifyMessage

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited()

static decodeDelimited(reader): MediaNotifyMessage

Defined in: WAProto/index.d.ts:16590

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

MediaNotifyMessage

MediaNotifyMessage

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode()

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:16563

Encodes the specified MediaNotifyMessage message. Does not implicitly verify messages.

Parameters

message

IMediaNotifyMessage

MediaNotifyMessage message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer


encodeDelimited()

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:16571

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

Parameters

message

IMediaNotifyMessage

MediaNotifyMessage message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer


fromObject()

static fromObject(object): MediaNotifyMessage

Defined in: WAProto/index.d.ts:16604

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

Parameters

object

Plain object

Returns

MediaNotifyMessage

MediaNotifyMessage


getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:16625

Gets the default type url for MediaNotifyMessage

Parameters

typeUrlPrefix?

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject()

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:16612

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

Parameters

message

MediaNotifyMessage

MediaNotifyMessage

options?

IConversionOptions

Conversion options

Returns

object

Plain object


verify()

static verify(message): null | string

Defined in: WAProto/index.d.ts:16597

Verifies a MediaNotifyMessage message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not