MigratoryData Client API for iOS
Developer's Guide and Reference Manual
MigratoryDataClient.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2007-2019 Migratory Data Systems (http://migratorydata.com)
3  * ALL RIGHTS RESERVED. Use is subject to license terms.
4  */
5 #import <Foundation/Foundation.h>
8 
10 @class MigratoryPushClientImpl;
11 
83 @interface MigratoryDataClient : NSObject {
84  @private
85  MigratoryPushClientImpl *_pushClientImpl;
86 }
87 
91 - (id) init;
92 
102 - (void) setLogType: (LogType)logLevel;
103 
110 - (void) setListener: (NSObject<MigratoryDataListener> *)listener;
111 
178 - (void) setServers: (NSArray *)servers;
179 
202 - (void) subscribe: (NSArray *)subjects;
203 
236 - (void) subscribeWithConflation: (NSArray *)subjects conflationTimeMillis:(int)conflationMillis;
237 
238 
247 - (void) unsubscribe: (NSArray *)subjects;
248 
260 - (void) setEncryption: (BOOL)encryption;
261 
276 - (void) setEntitlementToken: (NSString *)token;
277 
283 - (NSArray *) getSubjects;
284 
294 - (void) setServersDownBeforeNotify: (int)n DEPRECATED_MSG_ATTRIBUTE("Use notifyAfterReconnectRetries instead");
295 
303 - (void) notifyAfterReconnectRetries: (int)n;
304 
314 - (void) publish: (MigratoryDataMessage *)message;
315 
335 - (void) pause;
336 
350 - (void) resume;
351 
357 - (void) dispose;
358 
364 - (void) setQuickReconnectMaxRetries:(int) retries;
365 
412 - (void) setQuickReconnectInitialDelay:(int) seconds;
413 
425 - (void) setReconnectPolicy:(NSString* ) policy;
426 
435 - (void) setReconnectTimeInterval:(int) seconds;
436 
444 - (void) setReconnectMaxDelay:(int) seconds;
445 
456 - (void) setExternalToken: (NSString *)externalToken;
457 
458 - (void) setNumberOfHistoricalMessages:(int) number;
459 
461 - (void) ping;
463 
464 @end
id init()
Create a MigratoryDataClient object.
Include the declaration of the MigratoryDataListener class.
Include global constants and typedefs.
Represent a message.
Definition: MigratoryDataMessage.h:16
void dispose()
Disconnect from the connected MigratoryData server and dispose the resources used by the connection...
Implementations of this interface can handle the real-time messages received for the subscribed subje...
Definition: MigratoryDataListener.h:18
void resume()
Resume the API operation.
NSArray * getSubjects()
Return the list of subscribed subjects.
This class implements all the necessary operations for connecting to a cluster of one or more Migrato...
Definition: MigratoryDataClient.h:83
void pause()
Pause the API operation.