ProcessMetaData

class ProcessMetaData(json: JSONObject)

Constructors

Link copied to clipboard
fun ProcessMetaData(json: JSONObject)

Properties

Link copied to clipboard
val action: String

String: The action to done: submit, complete, cancel, draft, escalated, update.

Link copied to clipboard
val creationDate: Long

Long:(Timestamp) Date of creation of process (version 1)

Link copied to clipboard
val creatorDate: Long

Long:(Timestamp) The date of this version of the process

Link copied to clipboard
val creatorTimezone: String

String: The name of the sender's timezone (eg "Europe/Paris")

Link copied to clipboard
val draftVersion: Int

Int: The draft version of the process

Link copied to clipboard
val due: Boolean

Boolean: Whether due date is set.

Link copied to clipboard
val dueDate: Long = 0

Long:(Timestamp) The due date, or null if not set.

Link copied to clipboard
val escalationLevel: Int

Int: Denotes if this process step was escalated and to how many levels. Must be either null, meaning that the current step was not escalated (either because no escalation was defined for this version or the escalation conditions were not met), or a positive integer denoting the level.

Link copied to clipboard
val initiator: String

String: Phone number @ fqdn of the subscriber that initiated the process

Link copied to clipboard
val initiatorName: String

String: Name of the subscriber that initiated the process

Link copied to clipboard
val isRepeat: Boolean

Boolean: Whether this process is a repeat (so generated by the server).

Link copied to clipboard
val label: String

String: The process name to display in ui.

Link copied to clipboard
val lastRepeat: Boolean

Boolean: For repeated process, flag for the last repeat.

Link copied to clipboard
val nextEscalationDate: Long = 0

Long:(Timestamp) date and time when the process should be escalated to recipients, or null if not set.

Link copied to clipboard
val parentCreationDate: Long = 0

Long:(Timestamp) The parent process creation datetime for repeat processes

Link copied to clipboard
val parentProcessId: String

String: For repeated process, the parent process id.

Link copied to clipboard
val participants: List<RecipientModel>

List<String> Includes all participants, including initiator, and current recipients.

Link copied to clipboard
val priority: Int

Int: The priority of the process: 1 - low, 2 - medium, 3 - high

Link copied to clipboard
val priorityUsed: Boolean

Boolean: This field is used to indicate if the priority is used for the process. The false value ca be obtained only when the initiator did not enable the "Priority" in the options and the administrator did not enforce the priority.

Link copied to clipboard
val processTotalSteps: Int

Int: This field is used to indicate the total steps necessary for the completion of the process. For now, it is only used for processes with auto-routing. Default value will be null.

Link copied to clipboard
val processUUID: String

String: The process unique id

Link copied to clipboard
val recipients: List<RecipientModel>

List<String> Recipients of the current version

Link copied to clipboard
val recipientsNotAllowed: List<RecipientModel>? = null

List<String> Includes all recipients that do not have MyBusiness feature enabled

Link copied to clipboard
val repeat: Boolean

Boolean: Whether the repeat is set.

Link copied to clipboard
val repeatEndDate: Long = 0

Long:(Timestamp) date when the repeat will stop/stopped automatically

Link copied to clipboard
val repeatFrequencyUnit: Int = 0

Int: The unit of the repeat frequency: 1 (day), 2 (week), 3 (month), 4 (hour)

Link copied to clipboard
val repeatFrequencyValue: Int = 0

Int: The value of repeat frequency (number of days/weeks/months)

Link copied to clipboard
val repeatOn: String? = null

String: (only for monthly frequency) ordered comma separated list of number of the day in month. Values should be between 1 and 31.

Link copied to clipboard
val scheduled: Boolean

Boolean: Whether scheduled delivery is set.

Link copied to clipboard
val scheduledDate: Long = 0

Long:(Timestamp) date when the process should be submitted to recipients and initiator by the server, or null if not set.

Link copied to clipboard
val sender: String

String: Phone number @ fqdn of the subscriber that submits this version

Link copied to clipboard
val senderName: String

String: Name of the subscriber that submits this version

Link copied to clipboard
val serverDate: Long

Long:(Timestamp) The date at which the server has handled the ProcessUpdate message.

Link copied to clipboard
val subVersion: Int

Int: The process subVersion. Starts at 1.

Link copied to clipboard
val tag: String

String: The template tag

Link copied to clipboard
val templateUUID: String

String: The template unique id

Link copied to clipboard
val version: Int

Int: The version of the process