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.



21860
21861
21862
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21860

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) 


21827
21828
21829
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21827

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) 


21836
21837
21838
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21836

def gender
  @gender
end

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

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

Returns:



21841
21842
21843
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21841

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:



21846
21847
21848
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21846

def invitee_info
  @invitee_info
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


21851
21852
21853
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21851

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) 


21858
21859
21860
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21858

def user_mention_error
  @user_mention_error
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21865
21866
21867
21868
21869
21870
21871
21872
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21865

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