TTEscalation Class Reference

Inherits from NSManagedObject
Declared in TTEscalation.h

Overview

An object representing an escalation occurrence. Each escalation occurrence follows the rules of an escalation policy.

  actionDate

Date of the last action taken (escalation cancelled, escalation acknowledged)

@property (nullable, nonatomic, copy) NSDate *actionDate

Declared In

TTEscalation.h

  actionUserName

Username of the user who took the last action.

@property (nullable, nonatomic, copy) NSString *actionUserName

Declared In

TTEscalation.h

  actionUserToken

User token of the user who took the last action.

@property (nullable, nonatomic, copy) NSString *actionUserToken

Declared In

TTEscalation.h

  alwaysEscalate

BOOL indicating whether escalation is always on for every message sent to the target.

@property (nullable, nonatomic, copy) NSNumber *alwaysEscalate

Declared In

TTEscalation.h

  backup1EscalationDuration

Amount of time in minutes allowed for the first back up role/user to answer before message gets sent to the second back up role/user.

@property (nullable, nonatomic, copy) NSNumber *backup1EscalationDuration

Declared In

TTEscalation.h

  backup2EscalationDuration

Amount of time in minutes allowed for the second back up role/user to answer before escalation is marked with a “No Response” resolution.

@property (nullable, nonatomic, copy) NSNumber *backup2EscalationDuration

Declared In

TTEscalation.h

  destructionDuration

Amount of time the escalation group exists after escalation has completed (acknowledged, no response or cancelled).

@property (nullable, nonatomic, copy) NSNumber *destructionDuration

Declared In

TTEscalation.h

  displayToken

The token that appears in the title “ESCALATION #displayToken”.

@property (nullable, nonatomic, copy) NSString *displayToken

Declared In

TTEscalation.h

  escalationDuration

Amount of time in minutes allowed for the initial recipient to answer before message gets sent to the first back up role/user.

@property (nullable, nonatomic, copy) NSNumber *escalationDuration

Declared In

TTEscalation.h

  escalationGroupToken

The token that identifies the group created for the escalation.

@property (nullable, nonatomic, copy) NSString *escalationGroupToken

Declared In

TTEscalation.h

  escalationMessageToken

The token that identifies the escalated message.

@property (nullable, nonatomic, copy) NSString *escalationMessageToken

Declared In

TTEscalation.h

  expireDate

The date that the escalation expires (Shown in the escalation banner as “… This conversation expires expireDate”).

@property (nullable, nonatomic, copy) NSDate *expireDate

Declared In

TTEscalation.h

  level

The number representing where the escalation is in its lifecycle.

@property (nullable, nonatomic, copy) NSNumber *level

Discussion

@discussion level 0: escalated to original recipient.

level 1: escalated to first back up role/user.

level 2: escalated to second back up role/user.

Declared In

TTEscalation.h

  orgToken

The token that identifies the organization in which the escalation exists.

@property (nullable, nonatomic, copy) NSString *orgToken

Declared In

TTEscalation.h

  originalMessageToken

? * The token of the message that triggered the escalation.

@property (nullable, nonatomic, copy) NSString *originalMessageToken

Declared In

TTEscalation.h

  originalRecipientToken

The token of the initial recipient.

@property (nullable, nonatomic, copy) NSString *originalRecipientToken

Declared In

TTEscalation.h

  status

String representing the current status of the escalation.

@property (nullable, nonatomic, copy) NSString *status

Discussion

@discussion Possible values:

kTTKitEscalationStatusEscalated

kTTKitEscalationStatusInProgress

kTTKitEscalationStatusAcknowledged

kTTKitEscalationStatusCancelled

kTTKitEscalationStatusNoResponse

kTTKitEscalationStatusConversationEscalated

Declared In

TTEscalation.h

  token

String token that identifies the escalation.

@property (nullable, nonatomic, copy) NSString *token

Declared In

TTEscalation.h

  originalTarget

Initial recipient of the escalated message.

@property (nullable, nonatomic, retain) TTRole *originalTarget

Declared In

TTEscalation.h

  actionUser

The object that represents the user who took the last action (escalation cancelled, escalation acknowledged)

@property (nullable, nonatomic, retain) TTUser *actionUser

Discussion

Note: actionUserToken is actionUser’s token.

Declared In

TTEscalation.h

  backup1

Role/user to which the message gets sent after the initial recipient opts to skip or after the escalationDuration time expires before the initial recipient responds.

@property (nullable, nonatomic, retain) NSSet<TTUser*> *backup1

Declared In

TTEscalation.h

  backup2

Role/user to which the message gets sent after the first back up role/user opts to skip or after the backup1EscalationDuration time expires before the first back up role/user responds.

@property (nullable, nonatomic, retain) NSSet<TTUser*> *backup2

Declared In

TTEscalation.h

  escalationGroup

The group created after the initial recipient does not respond or chooses to skip.

@property (nullable, nonatomic, retain) TTGroup *escalationGroup

Declared In

TTEscalation.h

  messages

Contains the message that triggered the escalation and the escalated message.

@property (nullable, nonatomic, retain) NSSet<TTMessage*> *messages

Declared In

TTEscalation.h