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.



20918
20919
20920
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20918

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) 


20892
20893
20894
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20892

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) 


20901
20902
20903
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20901

def gender
  @gender
end

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

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

Returns:



20906
20907
20908
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20906

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:



20911
20912
20913
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20911

def invitee_info
  @invitee_info
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


20916
20917
20918
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20916

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20923
20924
20925
20926
20927
20928
20929
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20923

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)
end