Class UserMentionMetadata

Annotation metadata for user mentions (+/@/-).

Inheritance

object

UserMentionMetadata

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.CloudSearch.v1.Data

Assembly: Google.Apis.CloudSearch.v1.dll

Syntax

public class UserMentionMetadata : IDirectResponseSchema

Properties

DisplayName

Display name of the mentioned user. This field should remain empty when clients resolve a UserMention annotation. It will be filled in when a UserMention is generated by the Integration Server.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Gender

Gender of the mentioned user. One of "female", "male" or "other". Used for choosing accurate translations for strings that contain the UserMention, when these need to be constructed (e.g. task assignment update message). This field should remain empty when clients resolve a UserMention. It will be filled in when a UserMention is generated by the Integration Server.

Declaration

[JsonProperty("gender")]
public virtual string Gender { get; set; }

Property Value

Type	Description
string

Id

To be deprecated. Use invitee_info field instead. ID of the User mentioned. This field should remain empty when type == MENTION_ALL.

Declaration

[JsonProperty("id")]
public virtual UserId Id { get; set; }

Property Value

Type	Description
UserId

InviteeInfo

Invitee UserId and email used when mentioned. This field should remain empty when type == MENTION_ALL. Invitee_info.email is only used when a user is @-mentioned with an email address, and it will be empty when clients get messages from Backend.

Declaration

[JsonProperty("inviteeInfo")]
public virtual InviteeInfo InviteeInfo { get; set; }

Property Value

Type	Description
InviteeInfo

Type

Declaration

[JsonProperty("type")]
public virtual string Type { get; set; }

Property Value

Type	Description
string

UserMentionError

Specific reason for the user mention failing, for fine-grained processing by clients (i.e. specific error message for space limit exceeded case) IMPORTANT: Set this only for FAILED_TO_ADD case.

Declaration

[JsonProperty("userMentionError")]
public virtual string UserMentionError { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema