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.



17576
17577
17578
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17576

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) 


17550
17551
17552
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17550

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) 


17559
17560
17561
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17559

def gender
  @gender
end

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

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

Returns:



17564
17565
17566
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17564

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:



17569
17570
17571
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17569

def invitee_info
  @invitee_info
end

#type ⇒ String

Corresponds to the JSON property type

Returns:

  • (String) 


17574
17575
17576
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17574

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



17581
17582
17583
17584
17585
17586
17587
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 17581

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