Represents a Widget.
Package
@google-apps/chatConstructors
(constructor)(properties)
constructor(properties?: google.apps.card.v1.IWidget);Constructs a new Widget.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWidget
Properties to set |
Properties
buttonList
public buttonList?: (google.apps.card.v1.IButtonList|null);Widget buttonList.
columns
public columns?: (google.apps.card.v1.IColumns|null);Widget columns.
data
public data?: ("textParagraph"|"image"|"decoratedText"|"buttonList"|"textInput"|"selectionInput"|"dateTimePicker"|"divider"|"grid"|"columns");Widget data.
dateTimePicker
public dateTimePicker?: (google.apps.card.v1.IDateTimePicker|null);Widget dateTimePicker.
decoratedText
public decoratedText?: (google.apps.card.v1.IDecoratedText|null);Widget decoratedText.
divider
public divider?: (google.apps.card.v1.IDivider|null);Widget divider.
grid
public grid?: (google.apps.card.v1.IGrid|null);Widget grid.
horizontalAlignment
public horizontalAlignment: (google.apps.card.v1.Widget.HorizontalAlignment|keyof typeof google.apps.card.v1.Widget.HorizontalAlignment);Widget horizontalAlignment.
image
public image?: (google.apps.card.v1.IImage|null);Widget image.
selectionInput
public selectionInput?: (google.apps.card.v1.ISelectionInput|null);Widget selectionInput.
textInput
public textInput?: (google.apps.card.v1.ITextInput|null);Widget textInput.
textParagraph
public textParagraph?: (google.apps.card.v1.ITextParagraph|null);Widget textParagraph.
Methods
create(properties)
public static create(properties?: google.apps.card.v1.IWidget): google.apps.card.v1.Widget;Creates a new Widget instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IWidget
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Widget |
Widget instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.apps.card.v1.Widget;Decodes a Widget 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 |
Widget |
Widget |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.apps.card.v1.Widget;Decodes a Widget message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Widget |
Widget |
encode(message, writer)
public static encode(message: google.apps.card.v1.IWidget, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Widget message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWidget
Widget 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.IWidget, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Widget message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IWidget
Widget 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.Widget;Creates a Widget 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 |
Widget |
Widget |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Widget
| 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 Widget to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.apps.card.v1.Widget, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Widget message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Widget
Widget |
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 Widget message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|