CkoServerSentEvent Objective-C Reference Documentation

CkoServerSentEvent

Current Version: 9.5.0.75

Represents a server-sent event (SSE) received from an HTTP text/event-stream.

Object Creation

CkoServerSentEvent *obj = [[CkoServerSentEvent alloc] init];

Properties

Data
@property (nonatomic, readonly, copy) NSString *Data;
Introduced in version 9.5.0.58

The data for the server-side event. (If the "data" field was empty, then this will be empty.)

top
EventName
@property (nonatomic, readonly, copy) NSString *EventName;
Introduced in version 9.5.0.58

The name of the server-side event. (If the "event" field was not present, then this will be empty.)

top
LastEventId
@property (nonatomic, readonly, copy) NSString *LastEventId;
Introduced in version 9.5.0.58

The content of the "id" field, if present.

top
LastMethodSuccess
@property (nonatomic) BOOL LastMethodSuccess;

Indicate whether the last method call succeeded or failed. A value of YES indicates success, a value of NO indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = YES and failure = NO.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to YES. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Retry
@property (nonatomic, readonly, copy) NSNumber *Retry;
Introduced in version 9.5.0.58

The integer value of the "retry" field, if present. Otherwise 0.

top

Methods

LoadEvent
- (BOOL)LoadEvent:(NSString *)eventText;
Introduced in version 9.5.0.58

Loads the multi-line event text into this object. For example, the eventText for a Firebase event might look like this:

event: put
data: {"path": "/c", "data": {"foo": true, "bar": false}}

Returns YES for success, NO for failure.

top