.NET: DataObject - Devolens (formerly Cryptolens) Documentation

A Data Object used to store information. Namespace: SKM.V3
Version: 4.0.54. Both packages; all six documented target frameworks.

public class DataObject

Public Class DataObject

Used By: Get(List<DataObject>, string), AddDataObject(string, DataObject) Web API Reference

Properties

Id

A unique identification number for the Data Object.

public long Id { get; set; }

Public Property Id As Long

Type: long

IntValue

An int value (int32) to store.

public int IntValue { get; set; }

Public Property IntValue As Integer

Type: int Assigning this property changes only the local object. To save a change through the API, use SetIntValue(string, int) or its license-key overload.

Name

A way to identify the current object, for instance, OS_Version.

public string Name { get; set; }

Public Property Name As String

Type: string The API accepts names up to 100 characters long.

StringValue

A string value (text) to store. The API accepts up to 10,000 characters.

public string StringValue { get; set; }

Public Property StringValue As String

Type: string Assigning this property changes only the local object. To save a change through the API, use SetStringValue(string, string) or its license-key overload.

Constructors

DataObject()

Creates an empty DataObject object. This constructor does not send an API request.

public DataObject()

Public Sub New()

Methods

DecrementIntValue(string, int)

Decrements the IntValue by a given amount. (in SKM Platform).

public bool DecrementIntValue(string token, int decrementValue)

Public Function DecrementIntValue(token As String, decrementValue As Integer) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`decrementValue`	`int`	The number we should decrement by.

Returns: bool. Returns true if successful or false otherwise. See DecrementIntValue for the API parameters and permissions.

DecrementIntValue(string, int, LicenseKey)

Decrements the IntValue by a given amount. (in SKM Platform).

public bool DecrementIntValue(string token, int decrementValue, LicenseKey licenseKey)

Public Function DecrementIntValue(token As String, decrementValue As Integer, licenseKey As LicenseKey) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`decrementValue`	`int`	The number we should decrement by.
`licenseKey`	`LicenseKey`	The license key we should associate with this data object.

Returns: bool. Returns true if successful or false otherwise. See DecrementIntValue for the API parameters and permissions.

DecrementIntValue(string, int, LicenseKey, bool, int)

Decrements the IntValue by a given amount. (in SKM Platform).

public bool DecrementIntValue(string token, int decrementValue, LicenseKey licenseKey, bool enableBound = false, int lowerBound = 0)

Public Function DecrementIntValue(token As String, decrementValue As Integer, licenseKey As LicenseKey, Optional enableBound As Boolean = False, Optional lowerBound As Integer = 0) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`decrementValue`	`int`	The number we should decrement by.
`licenseKey`	`LicenseKey`	The license key we should associate with this data object.
`enableBound`	`bool`	If set to true, it will be possible to specify an lower bound. (for Decrement Int Value) For example, if you set the <code class=“paramref”>lowerBound</code> parameter (below) to 0, you will be able to decrement the int value until you reach zero (inclusive). Once the lower bound is reached, an error will be thrown.
`lowerBound`	`int`	The upper bound. It only works if <code class=“paramref”>enableBound</code> is set to true.

Returns: bool. Returns true if successful or false otherwise. See DecrementIntValue for the API parameters and permissions.

DecrementIntValue(string, int, bool, int)

Decrements the IntValue by a given amount. (in SKM Platform).

public bool DecrementIntValue(string token, int decrementValue, bool enableBound = false, int lowerBound = 0)

Public Function DecrementIntValue(token As String, decrementValue As Integer, Optional enableBound As Boolean = False, Optional lowerBound As Integer = 0) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`decrementValue`	`int`	The number we should decrement by.
`enableBound`	`bool`	If set to true, it will be possible to specify an lower bound. (for Decrement Int Value) For example, if you set the <code class=“paramref”>lowerBound</code> parameter (below) to 0, you will be able to decrement the int value until you reach zero (inclusive). Once the lower bound is reached, an error will be thrown.
`lowerBound`	`int`	The upper bound. It only works if <code class=“paramref”>enableBound</code> is set to true.

Returns: bool. Returns true if successful or false otherwise. See DecrementIntValue for the API parameters and permissions.

Equals(object)

Compares this object with another object using this type’s equality implementation.

public override bool Equals(object obj)

Public Overrides Function Equals(obj As Object) As Boolean

Parameters

Name	Type	Description
`obj`	`object`	The object to compare.

Returns: bool. True when the compared fields match; otherwise false. This is not a signature or license-validity check. Checks: This comparison is not signature verification or license validation.

IncrementIntValue(string, int)

Increments the IntValue by a given amount. (in SKM Platform).

public bool IncrementIntValue(string token, int incrementValue)

Public Function IncrementIntValue(token As String, incrementValue As Integer) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`incrementValue`	`int`	The number we should increment by.

Returns: bool. Returns true if successful or false otherwise. Note: for more details, please see IncrementIntValue

IncrementIntValue(string, int, LicenseKey)

Increments the IntValue by a given amount. (in SKM Platform).

public bool IncrementIntValue(string token, int incrementValue, LicenseKey licenseKey)

Public Function IncrementIntValue(token As String, incrementValue As Integer, licenseKey As LicenseKey) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`incrementValue`	`int`	The number we should increment by.
`licenseKey`	`LicenseKey`	The license key we should associate with this data object.

Returns: bool. Returns true if successful or false otherwise. Note: for more details, please see IncrementIntValue

IncrementIntValue(string, int, LicenseKey, bool, int)

Increments the IntValue by a given amount. (in SKM Platform).

public bool IncrementIntValue(string token, int incrementValue, LicenseKey licenseKey, bool enableBound = false, int upperBound = 0)

Public Function IncrementIntValue(token As String, incrementValue As Integer, licenseKey As LicenseKey, Optional enableBound As Boolean = False, Optional upperBound As Integer = 0) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`incrementValue`	`int`	The number we should increment by.
`licenseKey`	`LicenseKey`	The license key we should associate with this data object.
`enableBound`	`bool`	If set to true, it will be possible to specify an upper/lower bound. (for Increment Int Value) For example, if you set the <code class=“paramref”>upperBound</code> parameter (below) to 10, you will be able to increment the int value until you reach ten (inclusive). Once the upper bound is reached, an error will be thrown.
`upperBound`	`int`	The upper bound. It only works if <code class=“paramref”>enableBound</code> is set to true.

Returns: bool. Returns true if successful or false otherwise. Note: for more details, please see IncrementIntValue

IncrementIntValue(string, int, bool, int)

Increments the IntValue by a given amount. (in SKM Platform).

public bool IncrementIntValue(string token, int incrementValue, bool enableBound = false, int upperBound = 0)

Public Function IncrementIntValue(token As String, incrementValue As Integer, Optional enableBound As Boolean = False, Optional upperBound As Integer = 0) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`incrementValue`	`int`	The number we should increment by.
`enableBound`	`bool`	If set to true, it will be possible to specify an upper/lower bound. (for Increment Int Value) For example, if you set the <code class=“paramref”>upperBound</code> parameter (below) to 10, you will be able to increment the int value until you reach ten (inclusive). Once the upper bound is reached, an error will be thrown.
`upperBound`	`int`	The upper bound. It only works if <code class=“paramref”>enableBound</code> is set to true.

Returns: bool. Returns true if successful or false otherwise. Note: for more details, please see IncrementIntValue

SetIntValue(string, int)

Sets the IntValue to a new value (in Cryptolens).

public bool SetIntValue(string token, int value)

Public Function SetIntValue(token As String, value As Integer) As Boolean

Parameters

Name	Type	Description
`token`	`string`	An access token with the SetIntValue permission.
`value`	`int`	The new int value

Returns: bool. True when the API reports success; otherwise false. On success, this object’s IntValue is also updated. See SetIntValue for the API parameters and permissions.

SetIntValue(string, int, LicenseKey)

Sets the IntValue to a new value (in SKM Platform).

public bool SetIntValue(string token, int value, LicenseKey licenseKey)

Public Function SetIntValue(token As String, value As Integer, licenseKey As LicenseKey) As Boolean

Parameters

Name	Type	Description
`token`	`string`	An access token with the SetIntValue permission.
`value`	`int`	The new int value
`licenseKey`	`LicenseKey`	The license key we should associate with this data object.

Returns: bool. True when the API reports success; otherwise false. On success, this object’s IntValue is also updated. See SetIntValue for the API parameters and permissions.

SetStringValue(string, string)

Sets the StringValue to a new value (in SKM Platform).

public bool SetStringValue(string token, string value)

Public Function SetStringValue(token As String, value As String) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`value`	`string`	The new int value

Returns: bool. Returns true if successful or false otherwise. Note: for more details, please see SetStringValue

SetStringValue(string, string, LicenseKey)

Sets the StringValue to a new value (in SKM Platform).

public bool SetStringValue(string token, string value, LicenseKey licenseKey)

Public Function SetStringValue(token As String, value As String, licenseKey As LicenseKey) As Boolean

Parameters

Name	Type	Description
`token`	`string`	The access token. Read more at Auth
`value`	`string`	The new int value
`licenseKey`	`LicenseKey`	The license key we should associate with this data object.

Returns: bool. Returns true if successful or false otherwise. Note: for more details, please see SetStringValue

ToString()

Returns a text representation of this object.

public override string ToString()

Public Overrides Function ToString() As String

Returns: string. A string representation of this object. .NET SDK Reference · Reviewed Source Revision

​Properties

​Id

​IntValue

​Name

​StringValue

​Constructors

​DataObject()

​Methods

​DecrementIntValue(string, int)

​DecrementIntValue(string, int, LicenseKey)

​DecrementIntValue(string, int, LicenseKey, bool, int)

​DecrementIntValue(string, int, bool, int)

​Equals(object)

​IncrementIntValue(string, int)

​IncrementIntValue(string, int, LicenseKey)

​IncrementIntValue(string, int, LicenseKey, bool, int)

​IncrementIntValue(string, int, bool, int)

​SetIntValue(string, int)

​SetIntValue(string, int, LicenseKey)

​SetStringValue(string, string)

​SetStringValue(string, string, LicenseKey)

​ToString()

Properties

Id

IntValue

Name

StringValue

Constructors

DataObject()

Methods

DecrementIntValue(string, int)

DecrementIntValue(string, int, LicenseKey)

DecrementIntValue(string, int, LicenseKey, bool, int)

DecrementIntValue(string, int, bool, int)

Equals(object)

IncrementIntValue(string, int)

IncrementIntValue(string, int, LicenseKey)

IncrementIntValue(string, int, LicenseKey, bool, int)

IncrementIntValue(string, int, bool, int)

SetIntValue(string, int)

SetIntValue(string, int, LicenseKey)

SetStringValue(string, string)

SetStringValue(string, string, LicenseKey)

ToString()