Class protos.google.apps.card.v1.Chip (0.22.0)

Represents a Chip.

Package

@google-apps/chat

Constructors

(constructor)(properties)

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

Constructs a new Chip.

Parameter
Name Description
properties IChip

Properties to set

Properties

altText

public altText: string;

Chip altText.

disabled

public disabled: boolean;

Chip disabled.

enabled

public enabled: boolean;

Chip enabled.

icon

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

Chip icon.

label

public label: string;

Chip label.

onClick

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

Chip onClick.

Methods

create(properties)

public static create(properties?: google.apps.card.v1.IChip): google.apps.card.v1.Chip;

Creates a new Chip instance using the specified properties.

Parameter
Name Description
properties IChip

Properties to set

Returns
Type Description
Chip

Chip instance

decode(reader, length)

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

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

Chip

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Chip

Chip

encode(message, writer)

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

Encodes the specified Chip message. Does not implicitly messages.

Parameters
Name Description
message IChip

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

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

Parameters
Name Description
message IChip

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

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

Chip

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Chip

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Chip

Chip

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