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.



21005
21006
21007
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21005

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) 


20979
20980
20981
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20979

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) 


20988
20989
20990
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20988

def gender
  @gender
end

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

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

Returns:



20993
20994
20995
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20993

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:



20998
20999
21000
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 20998

def invitee_info
  @invitee_info
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


21003
21004
21005
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21003

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21010
21011
21012
21013
21014
21015
21016
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 21010

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