dismissGroup

功能介绍

说明

解散群，只有群主能调用。

注意

群状态字段会后台会设置为解散，群成员拉取已加入的群组时，此群组不再返回。

相关回调:
onGroupDismissed

iOS

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	String	是	群ID

返回结果

参数名称	参数类型	描述
~	~	无异常抛出则操作成功

代码示例

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

Android

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群ID

返回结果

参数名称	参数类型	描述
onSuccess	OIMSuccessCallback	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

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

Flutter

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase	是	回调接口
gid	String	是	群ID

返回结果

代码示例

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

            }

            @Override
            public void onSuccess(String data) {

            }
        },gid);

uni-app

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse>	调用成功回调
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

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(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
groupID	string	是	群ID

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('dismissGroup', IMSDK.uuid(), 'groupID')
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<OpenIMApiError>	调用失败回调

代码示例

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

OpenIMSDK.dismissGroup('groupID')
  .then(() => {
    // 调用成功
  })
  .catch((error) => {
    // 调用失败
  });

Unity

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase	是	回调函数
groupId	string	是	群ID

返回结果

代码示例

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

},groupId);