quitGroup

Feature Introduction

Description

Leave the group.

Note

(1) The group owner can leave the group only after transferring the ownership.

Related Callbacks: onJoinedGroupDeleted onGroupMemberDeleted

iOS

Function Prototype

  Future<dynamic> quitGroup({
    required String groupID,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
gid	String	Yes	Group ID

Return Results

Parameter Name	Parameter Type	Description
~	~	Operation successful if no exceptions are thrown

Code Example

   await OpenIM.iMManager.groupManager.quitGroup(
      groupID: '',
    );
    // todo

Android

Function Prototype

- (void)quitGroup:(NSString *)groupID
        onSuccess:(nullable OIMSuccessCallback)onSuccess
        onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	NSString	Yes	Group ID

Return Results

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Success return
onFailure	OIMFailureCallback	Failure return

Code Example

 [OIMManager.manager quitGroup:@""
                     onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

Function Prototype

 public void quitGroup(OnBase<String> callBack, String gid)

Input Parameters

Parameter Name	Parameter Type	Required	Description
callBack	OnBase	Yes	Callback interface
gid	String	Yes	Group ID

Return Results

Code Example

OpenIMClient.getInstance().groupManager.quitGroup(new OnBase<String>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(String data) {

            }
        });

uni-app

Function Prototype

IMSDK.quitGroup(groupID: string, operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID

Return Results

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();

// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();

// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();

IMSDK.quitGroup('groupID')
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('quitGroup', operationID: string, groupID: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID for issue tracking, unique; recommended to use current time and a random number
groupID	string	Yes	Group ID

Return Results

The function is transformed into a Promise using the openim-uniapp-polyfill package. When calling, use then and catch to determine and handle successful and failed callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('quitGroup', IMSDK.uuid(), 'groupID')
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

React-Native

Function Prototype

OpenIMSDKRN.quitGroup(groupID: string, operationID: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID for issue tracking, unique; recommended to use current time and a random number
groupID	string	Yes	Group ID

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Callback on successful call
Promise.catch()	Promise<CatchResponse>	Callback on failed call

Code Example

import OpenIMSDKRN from "open-im-sdk-rn";

OpenIMSDKRN.quitGroup('groupID', 'operationID')
  .then(() => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Unity

Function Prototype

public static void QuitGroup(OnBase<bool> cb, string groupId)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnBase	Yes	Callback
groupId	string	Yes	Group ID

Return Result

Code Example

IMSDK.QuitGroup((suc,errCode,errMsg)=>{

},groupId);