Class: LockstepSdk::AppEnrollmentCustomFieldModel

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

Overview

App enrollment and custom field merged into one

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ AppEnrollmentCustomFieldModel

Initialize the AppEnrollmentCustomFieldModel using the provided prototype



27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 27

def initialize(params = {})
    @app_enrollment_id = params.dig(:app_enrollment_id)
    @app_id = params.dig(:app_id)
    @name = params.dig(:name)
    @app_type = params.dig(:app_type)
    @group_key = params.dig(:group_key)
    @custom_field_definition_id = params.dig(:custom_field_definition_id)
    @custom_field_label = params.dig(:custom_field_label)
    @data_type = params.dig(:data_type)
    @sort_order = params.dig(:sort_order)
    @string_value = params.dig(:string_value)
    @numeric_value = params.dig(:numeric_value)
end

Instance Attribute Details

#app_enrollment_id ⇒ Uuid

Returns Unique id for the app enrollment.

Returns:

  • (Uuid) —

    Unique id for the app enrollment



43
44
45
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 43

def app_enrollment_id
  @app_enrollment_id
end

#app_id ⇒ Uuid

Returns Id of enrolled app.

Returns:

  • (Uuid) —

    Id of enrolled app



47
48
49
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 47

def app_id
  @app_id
end

#app_type ⇒ String

Returns Tag for what type of app the application is.

Returns:

  • (String) —

    Tag for what type of app the application is



55
56
57
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 55

def app_type
  @app_type
end

#custom_field_definition_id ⇒ Uuid

Returns Unique Id for the custom field definition.

Returns:

  • (Uuid) —

    Unique Id for the custom field definition



63
64
65
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 63

def custom_field_definition_id
  @custom_field_definition_id
end

#custom_field_label ⇒ String

Returns Text to display in-application for custom field.

Returns:

  • (String) —

    Text to display in-application for custom field



67
68
69
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 67

def custom_field_label
  @custom_field_label
end

#data_type ⇒ String

Returns Data type of the custom field definition.

Returns:

  • (String) —

    Data type of the custom field definition



71
72
73
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 71

def data_type
  @data_type
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).



59
60
61
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 59

def group_key
  @group_key
end

#name ⇒ String

Returns The name of the application.

Returns:

  • (String) —

    The name of the application



51
52
53
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 51

def name
  @name
end

#numeric_value ⇒ Double

Returns Number data for field.

Returns:

  • (Double) —

    Number data for field



83
84
85
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 83

def numeric_value
  @numeric_value
end

#sort_order ⇒ Int32

Returns Used for display logic when multiple app enrollment custom fields exist.

Returns:

  • (Int32) —

    Used for display logic when multiple app enrollment custom fields exist



75
76
77
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 75

def sort_order
  @sort_order
end

#string_value ⇒ String

Returns String of data for field.

Returns:

  • (String) —

    String of data for field



79
80
81
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 79

def string_value
  @string_value
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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 87

def as_json(options={})
    {
        'appEnrollmentId' => @app_enrollment_id,
        'appId' => @app_id,
        'name' => @name,
        'appType' => @app_type,
        'groupKey' => @group_key,
        'customFieldDefinitionId' => @custom_field_definition_id,
        'customFieldLabel' => @custom_field_label,
        'dataType' => @data_type,
        'sortOrder' => @sort_order,
        'stringValue' => @string_value,
        'numericValue' => @numeric_value,
    }
end

#to_json(*options) ⇒ String

Returns This object converted to a JSON string.

Returns:

  • (String) —

    This object converted to a JSON string



105
106
107
 
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 105

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