Class CommonEventObject

Represents information about the user's client, such as locale, host app, and platform. For Chat apps, CommonEventObject includes data submitted by users interacting with cards, like data entered in dialogs.

Inheritance

object

CommonEventObject

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.HangoutsChat.v1.Data

Assembly: Google.Apis.HangoutsChat.v1.dll

Syntax

public class CommonEventObject : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

FormInputs

A map containing the values that a user inputs in a widget from a card or dialog. The map keys are the string IDs assigned to each widget, and the values represent inputs to the widget. For details, see Process information inputted by users.

Declaration

[JsonProperty("formInputs")]
public virtual IDictionary<string, Inputs> FormInputs { get; set; }

Property Value

Type	Description
IDictionary<string, Inputs>

HostApp

The hostApp enum which indicates the app the add-on is invoked from. Always CHAT for Chat apps.

Declaration

[JsonProperty("hostApp")]
public virtual string HostApp { get; set; }

Property Value

Type	Description
string

InvokedFunction

Name of the invoked function associated with the widget. Only set for Chat apps.

Declaration

[JsonProperty("invokedFunction")]
public virtual string InvokedFunction { get; set; }

Property Value

Type	Description
string

Parameters

Custom parameters passed to the invoked function. Both keys and values must be strings.

Declaration

[JsonProperty("parameters")]
public virtual IDictionary<string, string> Parameters { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Platform

The platform enum which indicates the platform where the event originates (WEB, IOS, or ANDROID). Not supported by Chat apps.

Declaration

[JsonProperty("platform")]
public virtual string Platform { get; set; }

Property Value

Type	Description
string

TimeZone

The timezone ID and offset from Coordinated Universal Time (UTC). Only supported for the event types CARD_CLICKED and SUBMIT_DIALOG.

Declaration

[JsonProperty("timeZone")]
public virtual TimeZone TimeZone { get; set; }

Property Value

Type	Description
TimeZone

UserLocale

The full locale.displayName in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as "en-US".

Declaration

[JsonProperty("userLocale")]
public virtual string UserLocale { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema