Query Favorites | JuggleIM

Android
iOS
JavaScript
Flutter
ReactNative

Query the Favorites list, sorted by time in descending order. Pagination with count and offset is supported.

API Definition

/**
 * get favorite messages
 * @param option query options
 * @param callback result callback
 */
void getFavorite(GetFavoriteMessageOption option, IGetFavoriteMessageCallback callback);

Query the Favorites list, sorted by time in descending order. Pagination with count and offset is supported.

API Definition

/// get favorite messages
/// - Parameters:
///   - option: query options
///   - successBlock: success callback
///   - errorBlock: failure callback
- (void)getFavorite:(JGetFavoriteMessageOption *)option
            success:(void (^)(NSArray <JFavoriteMessage *> *messageList, NSString *offset))successBlock
              error:(void (^)(JErrorCode code))errorBlock;

Query the Favorites list, sorted by time in descending order. Pagination with limit and offset is supported.

Parameters

Name	Type	Required	Default	Description	Version
params	Object	Yes		Parameter object	1.0.0
message.limit	Number	No	20	Number of items per query	1.0.0
message.offset	String	No	empty	Empty by default. A successful query returns `offset`; pass the returned `offset` for the next query.	1.0.0

Success Callback

Name	Type	Description	Version
result	Object		1.0.0
result.offset	String	Identifier for retrieving more results. Pass `offset` when retrieving favorite messages again.	1.0.0
result.list	Array	Favorites list. When `list.length` is less than or equal to `limit`, all data has been retrieved and `offset` is returned as an empty string.	1.0.0
result.list[0]	Object	Favorited Message object.	1.0.0

Failure Callback

Name	Type	Description	Version
error	Object	A status code is provided when sending fails. Check `error.msg` directly or see status codes.	1.0.0

Code Example


let params = {
  offset: '',
  limit: 20
};

jim.getFavoriteMessages(params).then((result) => {

  let { offset, list } = result;

  // offset => pagination cursor

  // list => favorite-message list

}, (error) => {
  console.log(error)
});

Query the Favorites list, sorted by time in descending order. Pagination with count and offset is supported.

API Definition

/// get favorite messages
/// - Parameters:
///   - option: query options
Future<Result<FavoriteMessageResult>> getFavoriteMessages(GetFavoriteMessageOption option) async