Class: LockstepSdk::AppEnrollmentCustomFieldModel
- Inherits:
-
Object
- Object
- LockstepSdk::AppEnrollmentCustomFieldModel
- 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
-
#app_enrollment_id ⇒ Uuid
Unique id for the app enrollment.
-
#app_id ⇒ Uuid
Id of enrolled app.
-
#app_type ⇒ String
Tag for what type of app the application is.
-
#custom_field_definition_id ⇒ Uuid
Unique Id for the custom field definition.
-
#custom_field_label ⇒ String
Text to display in-application for custom field.
-
#data_type ⇒ String
Data type of the custom field definition.
-
#group_key ⇒ Uuid
The GroupKey uniquely identifies a single Lockstep Platform account.
-
#name ⇒ String
The name of the application.
-
#numeric_value ⇒ Double
Number data for field.
-
#sort_order ⇒ Int32
Used for display logic when multiple app enrollment custom fields exist.
-
#string_value ⇒ String
String of data for field.
Instance Method Summary collapse
-
#as_json(options = {}) ⇒ object
This object as a JSON key-value structure.
-
#initialize(params = {}) ⇒ AppEnrollmentCustomFieldModel
constructor
Initialize the AppEnrollmentCustomFieldModel using the provided prototype.
-
#to_json(*options) ⇒ String
This object converted to a JSON string.
Constructor Details
#initialize(params = {}) ⇒ AppEnrollmentCustomFieldModel
Initialize the AppEnrollmentCustomFieldModel using the provided prototype
26 27 28 29 30 31 32 33 34 35 36 37 38 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 26 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.
41 42 43 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 41 def app_enrollment_id @app_enrollment_id end |
#app_id ⇒ Uuid
Returns Id of enrolled app.
43 44 45 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 43 def app_id @app_id end |
#app_type ⇒ String
Returns Tag for what type of app the application is.
47 48 49 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 47 def app_type @app_type end |
#custom_field_definition_id ⇒ Uuid
Returns Unique Id for the custom field definition.
51 52 53 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 51 def custom_field_definition_id @custom_field_definition_id end |
#custom_field_label ⇒ String
Returns Text to display in-application for custom field.
53 54 55 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 53 def custom_field_label @custom_field_label end |
#data_type ⇒ String
Returns Data type of the custom field definition.
55 56 57 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 55 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).
49 50 51 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 49 def group_key @group_key end |
#name ⇒ String
Returns The name of the application.
45 46 47 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 45 def name @name end |
#numeric_value ⇒ Double
Returns Number data for field.
61 62 63 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 61 def numeric_value @numeric_value end |
#sort_order ⇒ Int32
Returns Used for display logic when multiple app enrollment custom fields exist.
57 58 59 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 57 def sort_order @sort_order end |
#string_value ⇒ String
Returns String of data for field.
59 60 61 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 59 def string_value @string_value end |
Instance Method Details
#as_json(options = {}) ⇒ object
Returns This object as a JSON key-value structure.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 64 def as_json(={}) { '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.
81 82 83 |
# File 'lib/lockstep_sdk/models/app_enrollment_custom_field_model.rb', line 81 def to_json(*) "[#{as_json(*).to_json(*)}]" end |