Class protos.google.apps.card.v1.Button (0.9.0)

Represents a Button.

Package

@google-apps/chat

Constructors

(constructor)(properties)

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

Constructs a new Button.

Parameter
Name Description
properties IButton

Properties to set

Properties

altText

public altText: string;

Button altText.

color

public color?: (google.type.IColor|null);

Button color.

disabled

public disabled: boolean;

Button disabled.

icon

public icon?: (google.apps.card.v1.IIcon|null);

Button icon.

onClick

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

Button onClick.

text

public text: string;

Button text.

Methods

create(properties)

public static create(properties?: google.apps.card.v1.IButton): google.apps.card.v1.Button;

Creates a new Button instance using the specified properties.

Parameter
Name Description
properties IButton

Properties to set

Returns
Type Description
Button

Button instance

decode(reader, length)

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

Decodes a Button 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
Button

Button

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Button

Button

encode(message, writer)

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

Encodes the specified Button message. Does not implicitly messages.

Parameters
Name Description
message IButton

Button 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.IButton, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IButton

Button 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.Button;

Creates a Button 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
Button

Button

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Button

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 Button to JSON.

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Button

Button

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 Button 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