Skip to content

Commit

Permalink
Fixed HeaderDocs for session handling
Browse files Browse the repository at this point in the history
  • Loading branch information
erkanyildiz committed Apr 22, 2017
1 parent 653759c commit 7768aee
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions Countly.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@
- (void)beginSession;

/**
* Updates session and sends @c update_session request with unsent session duration for manual session handling.
* @discussion This method needs to be called for starting a session only if @c manualSessionHandling flag is set on initial configuration. Otherwise; sessions will be handled automatically by default, and calling this method will have no effect.
* Updates session and sends unsent session duration for manual session handling.
* @discussion This method needs to be called for updating a session only if @c manualSessionHandling flag is set on initial configuration. Otherwise; sessions will be handled automatically by default, and calling this method will have no effect.
*/
- (void)updateSession;

/**
* Ends session and sends @c end_session request for manual session handling.
* @discussion This method needs to be called for starting a session only if @c manualSessionHandling flag is set on initial configuration. Otherwise; sessions will be handled automatically by default, and calling this method will have no effect.
* @discussion This method needs to be called for ending a session only if @c manualSessionHandling flag is set on initial configuration. Otherwise; sessions will be handled automatically by default, and calling this method will have no effect.
*/
- (void)endSession;

Expand Down
6 changes: 3 additions & 3 deletions CountlyConfig.h
Original file line number Diff line number Diff line change
Expand Up @@ -104,18 +104,18 @@ extern NSString* const CLYOpenUDID DEPRECATED_MSG_ATTRIBUTE("Use custom device I

/**
* For handling sessions manually.
* @discussion If set, SDK does not send @c begin_sesssion, @c update_session and @c end_session requests automatically. Methods for beginning, updating and ending sessions needs to be called manually.
* @discussion If set, SDK does not handle beginning, updating and ending sessions automatically. Methods @c beginSession, @c updateSession and @c endSession need to be called manually.
*/
@property (nonatomic) BOOL manualSessionHandling;

/**
* Update session period is used to send @c events and @c update_session requests to server periodically.
* Update session period is used for updating sessions and sending queued events to server periodically.
* @discussion If not set, it will be 60 seconds for @c iOS, @c tvOS & @c OSX, and 20 seconds for @c watchOS by default.
*/
@property (nonatomic) NSTimeInterval updateSessionPeriod;

/**
* Event send threshold is used to send @c events requests to server when number of recorded custom events reaches, without waiting for next @c update_session tick defined by @c updateSessionPeriod.
* Event send threshold is used for sending queued events to server when number of recorded events reaches to it, without waiting for next update session defined by @c updateSessionPeriod.
* @discussion If not set, it will be 10 for @c iOS, @c tvOS & @c OSX, and 3 for @c watchOS by default.
*/
@property (nonatomic) NSUInteger eventSendThreshold;
Expand Down

0 comments on commit 7768aee

Please sign in to comment.