Class protos.google.apps.card.v1.DecoratedText (0.4.0)

Represents a DecoratedText.

Package

@google-apps/chat

Constructors

(constructor)(properties)

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

Constructs a new DecoratedText.

Parameter
NameDescription
properties IDecoratedText

Properties to set

Properties

bottomLabel

public bottomLabel: string;

DecoratedText bottomLabel.

button

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

DecoratedText button.

control

public control?: ("button"|"switchControl"|"endIcon");

DecoratedText control.

endIcon

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

DecoratedText endIcon.

icon

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

DecoratedText icon.

onClick

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

DecoratedText onClick.

startIcon

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

DecoratedText startIcon.

switchControl

public switchControl?: (google.apps.card.v1.DecoratedText.ISwitchControl|null);

DecoratedText switchControl.

text

public text: string;

DecoratedText text.

topLabel

public topLabel: string;

DecoratedText topLabel.

wrapText

public wrapText: boolean;

DecoratedText wrapText.

Methods

create(properties)

public static create(properties?: google.apps.card.v1.IDecoratedText): google.apps.card.v1.DecoratedText;

Creates a new DecoratedText instance using the specified properties.

Parameter
NameDescription
properties IDecoratedText

Properties to set

Returns
TypeDescription
DecoratedText

DecoratedText instance

decode(reader, length)

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

Decodes a DecoratedText message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
DecoratedText

DecoratedText

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
DecoratedText

DecoratedText

encode(message, writer)

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

Encodes the specified DecoratedText message. Does not implicitly messages.

Parameters
NameDescription
message IDecoratedText

DecoratedText message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IDecoratedText

DecoratedText message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

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

Plain object

Returns
TypeDescription
DecoratedText

DecoratedText

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for DecoratedText

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this DecoratedText to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message DecoratedText

DecoratedText

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a DecoratedText message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not