Class: Google::Apis::CloudsearchV1::UserMentionMetadata

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UserMentionMetadata

Returns a new instance of UserMentionMetadata.



21087
21088
21089
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21087

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#display_name ⇒ String

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. Corresponds to the JSON property displayName

Returns:

  • (String) 


21054
21055
21056
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21054

def display_name
  @display_name
end

#gender ⇒ String

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. Corresponds to the JSON property gender

Returns:

  • (String) 


21063
21064
21065
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21063

def gender
  @gender
end

#id ⇒ Google::Apis::CloudsearchV1::UserId

Primary key for User resource. Corresponds to the JSON property id

Returns:



21068
21069
21070
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21068

def id
  @id
end

#invitee_info ⇒ Google::Apis::CloudsearchV1::InviteeInfo

Invitee information from a Dynamite invitation. See go/dynamite-invitee-mgmt. Corresponds to the JSON property inviteeInfo

Returns:



21073
21074
21075
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21073

def invitee_info
  @invitee_info
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


21078
21079
21080
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21078

def type
  @type
end

#user_mention_error ⇒ String

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. Corresponds to the JSON property userMentionError

Returns:

  • (String) 


21085
21086
21087
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21085

def user_mention_error
  @user_mention_error
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21092
21093
21094
21095
21096
21097
21098
21099
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21092

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @gender = args[:gender] if args.key?(:gender)
  @id = args[:id] if args.key?(:id)
  @invitee_info = args[:invitee_info] if args.key?(:invitee_info)
  @type = args[:type] if args.key?(:type)
  @user_mention_error = args[:user_mention_error] if args.key?(:user_mention_error)
end