urbanairship-core/com.urbanairship.actions/ActionValue/wrap

wrap

@NonNull
open fun wrap(@Nullable value: String): ActionValue

Wraps a String as an ActionValue.

Return

The ActionValue object.

Parameters

value

The action's value as a string.

@NonNull
open fun wrap(value: Int): ActionValue

Wraps an int as an ActionValue.

Return

The ActionValue object.

Parameters

value

The action's value as an int.

@NonNull
open fun wrap(value: Long): ActionValue

Wraps a long as an ActionValue.

Return

The ActionValue object.

Parameters

value

The action's value as a long.

@NonNull
open fun wrap(value: Char): ActionValue

Wraps a char as an ActionValue.

Return

The ActionValue object.

Parameters

value

The action's value as a char.

@NonNull
open fun wrap(value: Boolean): ActionValue

Wraps a boolean as an ActionValue.

Return

The ActionValue object.

Parameters

value

The action's value as a boolean.

@NonNull
open fun wrap(@Nullable value: JsonSerializable): ActionValue

Wraps a JsonSerializable object as an ActionValue.

Return

The ActionValue object.

Parameters

value

The action's value as a JsonSerializable object.

@NonNull
open fun wrap(@Nullable object: Any): ActionValue

Wraps a com.urbanairship.json.JsonValue compatible object as an ActionValue.

Return

The ActionValue object.

Parameters

object

The action's value.

Throws

If the object is unable to be wrapped into an action value.