dismissGroup

Description

info

Dismiss the group, only the group owner can call.

Note

The group status field will be set to dismissed in the backend. When group members pull the joined groups, this group will no longer be returned.

Related Callbacks:
onGroupDismissed

iOS

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	String	Yes	Group ID

Return Result

Parameter Name	Parameter Type	Description
~	~	Operation successful if no exception thrown

Code Example

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

Android

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	NSString	Yes	Group ID

Return Result

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Success
onFailure	OIMFailureCallback	Failure

Code Example

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

Flutter

Function Prototype

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

Input Parameters

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

Return Result

Code Example

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

            }

            @Override
            public void onSuccess(String data) {

            }
        },gid);

uni-app

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID

Return Result

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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.dismissGroup('groupID')
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
groupID	string	Yes	Group ID

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure 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('dismissGroup', IMSDK.uuid(), 'groupID')
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

OpenIMSDK.dismissGroup(groupID: string, operationID?: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

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

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.dismissGroup('groupID')
  .then(() => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

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

Input Parameters

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

Return Result

Code Example

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

},groupId);