Class protos.google.apps.card.v1.SelectionInput (0.6.0)

Represents a SelectionInput.

Package

@google-apps/chat

Constructors

(constructor)(properties)

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

Constructs a new SelectionInput.

Parameter
Name Description
properties ISelectionInput

Properties to set

Properties

externalDataSource

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

SelectionInput externalDataSource.

items

public items: google.apps.card.v1.SelectionInput.ISelectionItem[];

SelectionInput items.

label

public label: string;

SelectionInput label.

multiSelectDataSource

public multiSelectDataSource?: ("externalDataSource"|"platformDataSource");

SelectionInput multiSelectDataSource.

multiSelectMaxSelectedItems

public multiSelectMaxSelectedItems: number;

SelectionInput multiSelectMaxSelectedItems.

multiSelectMinQueryLength

public multiSelectMinQueryLength: number;

SelectionInput multiSelectMinQueryLength.

name

public name: string;

SelectionInput name.

onChangeAction

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

SelectionInput onChangeAction.

platformDataSource

public platformDataSource?: (google.apps.card.v1.SelectionInput.IPlatformDataSource|null);

SelectionInput platformDataSource.

type

public type: (google.apps.card.v1.SelectionInput.SelectionType|keyof typeof google.apps.card.v1.SelectionInput.SelectionType);

SelectionInput type.

Methods

create(properties)

public static create(properties?: google.apps.card.v1.ISelectionInput): google.apps.card.v1.SelectionInput;

Creates a new SelectionInput instance using the specified properties.

Parameter
Name Description
properties ISelectionInput

Properties to set

Returns
Type Description
SelectionInput

SelectionInput instance

decode(reader, length)

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

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

SelectionInput

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SelectionInput

SelectionInput

encode(message, writer)

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

Encodes the specified SelectionInput message. Does not implicitly messages.

Parameters
Name Description
message ISelectionInput

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

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

Parameters
Name Description
message ISelectionInput

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

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

SelectionInput

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SelectionInput

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SelectionInput

SelectionInput

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