Class protos.google.apps.card.v1.Grid (0.13.0)

Represents a Grid.

Package

@google-apps/chat

Constructors

(constructor)(properties)

constructor(properties?: google.apps.card.v1.IGrid);

Constructs a new Grid.

Parameter
Name Description
properties IGrid

Properties to set

Properties

borderStyle

public borderStyle?: (google.apps.card.v1.IBorderStyle|null);

Grid borderStyle.

columnCount

public columnCount: number;

Grid columnCount.

items

public items: google.apps.card.v1.Grid.IGridItem[];

Grid items.

onClick

public onClick?: (google.apps.card.v1.IOnClick|null);

Grid onClick.

title

public title: string;

Grid title.

Methods

create(properties)

public static create(properties?: google.apps.card.v1.IGrid): google.apps.card.v1.Grid;

Creates a new Grid instance using the specified properties.

Parameter
Name Description
properties IGrid

Properties to set

Returns
Type Description
Grid

Grid instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.apps.card.v1.Grid;

Decodes a Grid message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
Grid

Grid

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.apps.card.v1.Grid;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Grid

Grid

encode(message, writer)

public static encode(message: google.apps.card.v1.IGrid, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Grid message. Does not implicitly messages.

Parameters
Name Description
message IGrid

Grid message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.apps.card.v1.IGrid, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGrid

Grid message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.apps.card.v1.Grid;

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

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
Grid

Grid

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Grid

Parameter
Name Description
typeUrlPrefix string

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

Returns
Type Description
string

The default type url

toJSON()

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

Converts this Grid to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Grid

Grid

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Grid message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not