Clear Message History

Parameters

Name	Type	Description	Version
conversation	Conversation	Conversation identifier	1.0.0
startTime	long	Messages before `startTime` are cleared. Pass `0` to use the current time.	1.0.0
callback	IMessageManager.ISimpleCallback	Result callback	1.0.0

Code Example

Conversation conversation = new Conversation(Conversation.ConversationType.GROUP, "groupId1");
JIM.getInstance().getMessageManager().clearMessages(conversation, 0, new IMessageManager.ISimpleCallback() {
    @Override
    public void onSuccess() {
        
    }

    @Override
    public void onError(int errorCode) {

    }
});

Parameters

Name	Type	Description	Version
conversation	JConversation	Conversation identifier	1.0.0
startTime	long long	Messages before `startTime` are cleared. Pass `0` to use the current time.	1.0.0
successBlock		Success callback	1.0.0
errorBlock		Failure callback	1.0.0

Code Example

JConversation *conversation = [[JConversation alloc] initWithConversationType:JConversationTypeGroup conversationId:@"groupId1"];
[JIM.shared.messageManager clearMessagesIn:conversation
                                  startTime:0
                                   success:^{
    
} error:^(JErrorCode errorCode) {
    
}];

Parameters

Name	Type	Required	Default	Description	Version
params	Object	Yes	-	Clear message history	1.0.0
params.conversationType	Number	Yes	-	Conversation type	1.0.0
params.conversationId	String	Yes	-	Conversation ID. For `PRIVATE` conversations, it is the recipient userId; for `GROUP` conversations, it is the group ID.	1.0.0
params.time	Number	Yes	-	Clear message history before a specified time. To clear all history, pass the `sentTime` of the last message in the conversation.	1.0.0

Success Callback

No parameters are returned. The callback indicates success when invoked.

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 { ConversationType } = JIM;

let params = {
  conversationType: ConversationType.PRIVATE,
  conversationId: 'userid2',
  time: 1702180128970
};

jim.clearMessage(params).then((result) => {
  console.log('clear messages successfully');
}, (error) => {
  console.log(error);
})

Parameters

Name	Type	Description	Version
conversation	Conversation	Conversation identifier	1.0.0
startTime	long	Messages before `startTime` are cleared.	1.0.0
callback	CommonCallback	Result callback	1.0.0

Code Example

let conver = new Conversation("userid1",1)
JuggleIm.instance.getMessageManager().clearMessages(conver,new Date().getTime(),(code)=>{

})

Parameters

Name	Type	Required	Default	Description	Version
conversation	Conversation	Yes		Conversation object. When the conversation type is `private`, the conversation ID is the other user's userId; when it is `group`, it is the group ID.	0.6.3
startTime	int	Yes		Timestamp. Messages earlier than this time are cleared. `0` indicates the default current time.	0.6.3
forAllUsers	bool	No	false	Message clearing scope. `true` clears message history for all users; `false` clears it only for the current user.	0.6.3

forAllUsers Use Cases

Group scenario: control clearing actions by permission. For example, administrators can clear message history for all members, while regular members can clear only their own message history.

Private-chat scenario: typically offers clearing only the current user's and the other participant's message history.

Code Example

Conversation conversation = Conversation(ConversationType.group, 'groupId1');
int startTime = 0;
bool forAllUsers = false;

await JuggleIm.instance.clearMessages(conversation, startTime, forAllUsers);