KaaClientPropertiesState Class Reference

Inherits from NSObject
Conforms to KaaClientState
Declared in KaaClientPropertiesState.h
KaaClientPropertiesState.m

Overview

Default implementation of KaaClientState protocol that uses file system to store Kaa client state.

– isConfigurationVersionUpdated

- (BOOL)isConfigurationVersionUpdated

Return Value

YES - if configuration version was updated, NO - if it wasn’t.

Discussion

Declared In

KaaClientState.h

– setTopicListHash:

Holds hash calculated from list of available topics. See TopicListHashCalculator for more info.

- (void)setTopicListHash:(int32_t)topicListHash

Discussion

Holds hash calculated from list of available topics. See TopicListHashCalculator for more info.

Declared In

KaaClientState.h

– isRegistred

Defines whether server knows about current endpoint profile.

- (BOOL)isRegistred

Discussion

Defines whether server knows about current endpoint profile.

Declared In

KaaClientState.h

– setIsRegistred:

Defines whether server knows about current endpoint profile.

- (void)setIsRegistred:(BOOL)isRegistred

Discussion

Defines whether server knows about current endpoint profile.

Declared In

KaaClientState.h

– needProfileResync

Defines whether server need profile resync.

- (BOOL)needProfileResync

Discussion

Defines whether server need profile resync.

Declared In

KaaClientState.h

– setNeedProfileResync:

Defines whether server need profile resync.

- (void)setNeedProfileResync:(BOOL)needProfileResync

Discussion

Defines whether server need profile resync.

Declared In

KaaClientState.h

– persist

Persists current client state.

- (void)persist

Discussion

Persists current client state.

Declared In

KaaClientState.h

– refreshEndpointAccessToken

Generates and stores new endpoint access token.

- (NSString *)refreshEndpointAccessToken

Return Value

New access token

Discussion

Generates and stores new endpoint access token.

Declared In

KaaClientState.h

– publicKeyAsBytes

Returns existing or generates new public key as bytes.

- (NSData *)publicKeyAsBytes

Discussion

Returns existing or generates new public key as bytes.

Declared In

KaaClientState.h

– publicKey

Returns existing or generates new public key.

- (SecKeyRef)publicKey

Discussion

Returns existing or generates new public key.

Declared In

KaaClientState.h

– privateKey

Returns existing or generates new private key.

- (SecKeyRef)privateKey

Discussion

Returns existing or generates new private key.

Declared In

KaaClientState.h

– endpointKeyHash

Unique endpoint identifier.

- (EndpointKeyHash *)endpointKeyHash

Discussion

Unique endpoint identifier.

Declared In

KaaClientState.h

– appStateSequenceNumber

Holds application state sequence number.

- (int32_t)appStateSequenceNumber

Discussion

Holds application state sequence number.

Declared In

KaaClientState.h

– profileHash

Holds endpoint profile hash.

- (EndpointObjectHash *)profileHash

Discussion

Holds endpoint profile hash.

Declared In

KaaClientState.h

– setAppStateSequenceNumber:

Holds application state sequence number.

- (void)setAppStateSequenceNumber:(int32_t)appStateSequenceNumber

Discussion

Holds application state sequence number.

Declared In

KaaClientState.h

– setProfileHash:

Holds endpoint profile hash.

- (void)setProfileHash:(EndpointObjectHash *)profileHash

Discussion

Holds endpoint profile hash.

Declared In

KaaClientState.h

– addTopic:

Adds topic with all its information.

- (void)addTopic:(Topic *)topic

Discussion

Adds topic with all its information.

Declared In

KaaClientState.h

– removeTopicId:

Remove topic with all its information by topic id.

- (void)removeTopicId:(int64_t)topicId

Discussion

Remove topic with all its information by topic id.

Declared In

KaaClientState.h

– addSubscriptionForTopicWithId:

Add subscription for topic by ID.

- (void)addSubscriptionForTopicWithId:(int64_t)topicId

Discussion

Add subscription for topic by ID.

Declared In

KaaClientState.h

– removeSubscriptionForTopicWithId:

Remove subscription for topic by ID.

- (void)removeSubscriptionForTopicWithId:(int64_t)topicId

Discussion

Remove subscription for topic by ID.

Declared In

KaaClientState.h

– updateSubscriptionInfoForTopicId:sequence:

Used to update subscription info.

- (BOOL)updateSubscriptionInfoForTopicId:(int64_t)topicId sequence:(int32_t)sequenceNumber

Discussion

Used to update subscription info.

Declared In

KaaClientState.h

– getNotificationSubscriptions

Return dictionary with notification subscriptions information with Topic id as key and sequence number of TopicSubscriptionInfo as value.

- (NSDictionary *)getNotificationSubscriptions

Return Value

Dictionary of <@(int64_t), @(int32_t)> as key-value.

Discussion

Return dictionary with notification subscriptions information with Topic id as key and sequence number of TopicSubscriptionInfo as value.

Declared In

KaaClientState.h

– getTopics

Topic

- (NSArray *)getTopics

Return Value

Array of topics

See Also

Declared In

KaaClientState.h

– setAttachedEndpoints:

<EndpointAccessToken, EndpointKeyHash> as key-value.

- (void)setAttachedEndpoints:(NSMutableDictionary *)attachedEndpoints

Return Value

<EndpointAccessToken, EndpointKeyHash> as key-value.

Declared In

KaaClientState.h

– setEndpointAccessToken:

Holds current endpoint access token.

- (void)setEndpointAccessToken:(NSString *)endpointAccessToken

Discussion

Holds current endpoint access token.

Declared In

KaaClientState.h

– endpointAccessToken

Holds current endpoint access token.

- (NSString *)endpointAccessToken

Discussion

Holds current endpoint access token.

Declared In

KaaClientState.h

– getAndIncrementEventSequenceNumber

Next event sequence number that could be used by the system.

- (int32_t)getAndIncrementEventSequenceNumber

Return Value

Next event sequence number that could be used by the system.

Declared In

KaaClientState.h

– setEventSequenceNumber:

Holds current event sequence number.

- (void)setEventSequenceNumber:(int32_t)eventSequenceNumber

Discussion

Holds current event sequence number.

Declared In

KaaClientState.h

– isAttachedToUser

Defines whether endpoint is attached to its user.

- (BOOL)isAttachedToUser

Discussion

Defines whether endpoint is attached to its user.

Declared In

KaaClientState.h

– setIsAttachedToUser:

Defines whether endpoint is attached to its user.

- (void)setIsAttachedToUser:(BOOL)isAttachedToUser

Discussion

Defines whether endpoint is attached to its user.

Declared In

KaaClientState.h

– clean

Cleans up persisted client state.

- (void)clean

Discussion

Cleans up persisted client state.

Declared In

KaaClientState.h