Class protos.google.chat.v1.Message (0.6.0)

Represents a Message.

Package

@google-apps/chat

Constructors

(constructor)(properties)

constructor(properties?: google.chat.v1.IMessage);

Constructs a new Message.

Parameter
Name Description
properties IMessage

Properties to set

Properties

accessoryWidgets

public accessoryWidgets: google.chat.v1.IAccessoryWidget[];

Message accessoryWidgets.

actionResponse

public actionResponse?: (google.chat.v1.IActionResponse|null);

Message actionResponse.

annotations

public annotations: google.chat.v1.IAnnotation[];

Message annotations.

argumentText

public argumentText: string;

Message argumentText.

attachedGifs

public attachedGifs: google.chat.v1.IAttachedGif[];

Message attachedGifs.

attachment

public attachment: google.chat.v1.IAttachment[];

Message attachment.

cards

public cards: google.chat.v1.ContextualAddOnMarkup.ICard[];

Message cards.

cardsV2

public cardsV2: google.chat.v1.ICardWithId[];

Message cardsV2.

clientAssignedMessageId

public clientAssignedMessageId: string;

Message clientAssignedMessageId.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Message createTime.

deleteTime

public deleteTime?: (google.protobuf.ITimestamp|null);

Message deleteTime.

deletionMetadata

public deletionMetadata?: (google.chat.v1.IDeletionMetadata|null);

Message deletionMetadata.

emojiReactionSummaries

public emojiReactionSummaries: google.chat.v1.IEmojiReactionSummary[];

Message emojiReactionSummaries.

fallbackText

public fallbackText: string;

Message fallbackText.

formattedText

public formattedText: string;

Message formattedText.

lastUpdateTime

public lastUpdateTime?: (google.protobuf.ITimestamp|null);

Message lastUpdateTime.

matchedUrl

public matchedUrl?: (google.chat.v1.IMatchedUrl|null);

Message matchedUrl.

name

public name: string;

Message name.

privateMessageViewer

public privateMessageViewer?: (google.chat.v1.IUser|null);

Message privateMessageViewer.

quotedMessageMetadata

public quotedMessageMetadata?: (google.chat.v1.IQuotedMessageMetadata|null);

Message quotedMessageMetadata.

sender

public sender?: (google.chat.v1.IUser|null);

Message sender.

slashCommand

public slashCommand?: (google.chat.v1.ISlashCommand|null);

Message slashCommand.

space

public space?: (google.chat.v1.ISpace|null);

Message space.

text

public text: string;

Message text.

thread

public thread?: (google.chat.v1.IThread|null);

Message thread.

threadReply

public threadReply: boolean;

Message threadReply.

Methods

create(properties)

public static create(properties?: google.chat.v1.IMessage): google.chat.v1.Message;

Creates a new Message instance using the specified properties.

Parameter
Name Description
properties IMessage

Properties to set

Returns
Type Description
Message

Message instance

decode(reader, length)

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

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

Message

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.chat.v1.Message;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Message

Message

encode(message, writer)

public static encode(message: google.chat.v1.IMessage, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Message message. Does not implicitly messages.

Parameters
Name Description
message IMessage

Message 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.chat.v1.IMessage, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IMessage

Message 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.chat.v1.Message;

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

Message

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Message

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Message

Message

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