CPCallState

Objective-C

@interface CPCallState : NSObject

Swift

class CPCallState : NSObject

Contains status information of the call.

Since

1.0.0

  • Enum type of CallState

    Since

    1.0.0

    Declaration

    Objective-C

    @property (nonatomic, readonly) CPCallStates type;

    Swift

    var type: CPCallStates { get }

    Return Value

    CPCallStates

  • Reason of state transition

    Since

    1.0.0

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull reason;

    Swift

    var reason: String { get }

    Return Value

    String

  • HTTP status code

    Since

    1.0.0

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSInteger statusCode;

    Swift

    var statusCode: Int { get }

    Return Value

    NSInteger

  • Creates an CallState oject with specified type

    Since

    1.0.0

    Declaration

    Objective-C

    - (nonnull id)initWithType:(CPCallStates)type;

    Swift

    init(type: CPCallStates)

    Parameters

    type

    Type of state as CPCallStates

    Return Value

    CPCallState object

  • Creates an CallState oject with specified type and reson

    Since

    1.0.0

    Declaration

    Objective-C

    - (nonnull id)initWithType:(CPCallStates)type
                 andReason:(nonnull NSString *)reason;

    Swift

    init(type: CPCallStates, andReason reason: String)

    Parameters

    type

    Type of state as CPCallStates
    reason

    Reason of CallState transition as String

    Return Value

    CPCallState object

  • Creates an CallState oject with specified type and reson and http code

    Since

    1.0.0

    Declaration

    Objective-C

    - (nonnull id)initWithType:(CPCallStates)type
                 andReason:(nonnull NSString *)reason
             andStatusCode:(NSInteger)statusCode;

    Swift

    init(type: CPCallStates, andReason reason: String, andStatusCode statusCode: Int)

    Parameters

    type

    Type of state as CPCallStates
    reason

    Reason of CallState transition as String
    statusCode

    HTTP code comes from CPaaS for state transition

    Return Value

    CPCallState object