Class protos.google.cloud.channel.v1.Media

Represents a Media.

Package

@google-cloud/channel!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.channel.v1.IMedia);

Constructs a new Media.

Parameter
TypeNameDescription
IMediaproperties

Properties to set

Properties

content

public content: string;

Media content.

Property Value
TypeDescription
string

title

public title: string;

Media title.

Property Value
TypeDescription
string

type

public type: (google.cloud.channel.v1.MediaType|keyof typeof google.cloud.channel.v1.MediaType);

Media type.

Property Value
TypeDescription
(google.cloud.channel.v1.MediaType|keyof typeof google.cloud.channel.v1.MediaType)

Methods

create(properties)

public static create(properties?: google.cloud.channel.v1.IMedia): google.cloud.channel.v1.Media;

Creates a new Media instance using the specified properties.

Parameter
TypeNameDescription
IMediaproperties

Properties to set

Returns
TypeDescription
google.cloud.channel.v1.Media

Media instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.channel.v1.Media;

Decodes a Media message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.channel.v1.Media

Media

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.channel.v1.Media;

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.channel.v1.Media

Media

encode(message, writer)

public static encode(message: google.cloud.channel.v1.IMedia, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Media message. Does not implicitly messages.

Parameters
TypeNameDescription
IMediamessage

Media message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.channel.v1.IMedia, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
IMediamessage

Media message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.channel.v1.Media;

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

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.cloud.channel.v1.Media

Media

toJSON()

public toJSON(): { [k: string]: any };

Converts this Media to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.channel.v1.Media, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
TypeNameDescription
google.cloud.channel.v1.Mediamessage

Media

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Media message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not