Class: LockstepSdk::ActivityXRefModel

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/models/activity_xref_model.rb

Overview

Represents links between an Activity and another record.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ ActivityXRefModel

Initialize the ActivityXRefModel using the provided prototype



27
28
29
30
31
32
33
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 27

def initialize(params = {})
    @activity_xref_id = params.dig(:activity_xref_id)
    @activity_id = params.dig(:activity_id)
    @group_key = params.dig(:group_key)
    @table_key = params.dig(:table_key)
    @object_key = params.dig(:object_key)
end

Instance Attribute Details

#activity_id ⇒ Uuid

Returns The ID of the activity to which this reference belongs.

Returns:

  • (Uuid) —

    The ID of the activity to which this reference belongs.



41
42
43
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 41

def activity_id
  @activity_id
end

#activity_xref_id ⇒ Uuid

Returns The unique ID of this record, automatically assigned by Lockstep when this is added to the Lockstep platform.

Returns:

  • (Uuid) —

    The unique ID of this record, automatically assigned by Lockstep when this is added to the Lockstep platform.



37
38
39
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 37

def activity_xref_id
  @activity_xref_id
end

#group_key ⇒ Uuid

Returns The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).

Returns:

  • (Uuid) —

    The GroupKey uniquely identifies a single Lockstep Platform account. All records for this account will share the same GroupKey value. GroupKey values cannot be changed once created. For more information, see [Accounts and GroupKeys](developer.lockstep.io/docs/accounts-and-groupkeys).



45
46
47
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 45

def group_key
  @group_key
end

#object_key ⇒ String

Returns The ID of the object the activity reference is associated with.

Returns:

  • (String) —

    The ID of the object the activity reference is associated with



53
54
55
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 53

def object_key
  @object_key
end

#table_key ⇒ String

Returns The name of the table the activity reference is associated with.

Returns:

  • (String) —

    The name of the table the activity reference is associated with



49
50
51
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 49

def table_key
  @table_key
end

Instance Method Details

#as_json(options = {}) ⇒ object

Returns This object as a JSON key-value structure.

Returns:

  • (object) —

    This object as a JSON key-value structure



57
58
59
60
61
62
63
64
65
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 57

def as_json(options={})
    {
        'activityXRefId' => @activity_xref_id,
        'activityId' => @activity_id,
        'groupKey' => @group_key,
        'tableKey' => @table_key,
        'objectKey' => @object_key,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



69
70
71
 
# File 'lib/lockstep_sdk/models/activity_xref_model.rb', line 69

def to_json(*options)
    "[#{as_json(*options).to_json(*options)}]"
end