Class protos.google.apps.card.v1.OnClick (0.10.0)

Represents an OnClick.

Package

@google-apps/chat

Constructors

(constructor)(properties)

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

Constructs a new OnClick.

Parameter
Name Description
properties IOnClick

Properties to set

Properties

action

public action?: (google.apps.card.v1.IAction|null);

OnClick action.

card

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

OnClick card.

data

public data?: ("action"|"openLink"|"openDynamicLinkAction"|"card");

OnClick data.

openDynamicLinkAction

public openDynamicLinkAction?: (google.apps.card.v1.IAction|null);

OnClick openDynamicLinkAction.

public openLink?: (google.apps.card.v1.IOpenLink|null);

OnClick openLink.

Methods

create(properties)

public static create(properties?: google.apps.card.v1.IOnClick): google.apps.card.v1.OnClick;

Creates a new OnClick instance using the specified properties.

Parameter
Name Description
properties IOnClick

Properties to set

Returns
Type Description
OnClick

OnClick instance

decode(reader, length)

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

Decodes an OnClick 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
OnClick

OnClick

decodeDelimited(reader)

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

Decodes an OnClick message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
OnClick

OnClick

encode(message, writer)

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

Encodes the specified OnClick message. Does not implicitly messages.

Parameters
Name Description
message IOnClick

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

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

Parameters
Name Description
message IOnClick

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

Creates an OnClick 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
OnClick

OnClick

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OnClick

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message OnClick

OnClick

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 an OnClick 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