transferGroupOwner

Description

info

Transfer group ownership.

Note

(1) Each group can only have one owner;
(2) The caller must be the group owner of this group.

Related Callbacks:
onGroupInfoChanged
onGroupMemberInfoChanged

iOS

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	String	Yes	Group ID
userID	Sting	No	New owner user ID

Return Result

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

Code Example

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

Android

Function Prototype

- (void)transferGroupOwner:(NSString *)groupID
                  newOwner:(NSString *)userID
                 onSuccess:(nullable OIMSuccessCallback)onSuccess
                 onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	NSString	Yes	Group ID
userID	NSSting	No	New owner user ID

Return Result

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Success
onFailure	OIMFailureCallback	Failure

Code Example

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

Flutter

Function Prototype

public void transferGroupOwner(OnBase<String> base, String gid, String uid)

Input Parameters

Parameter Name	Parameter Type	Required	Description
callBack	OnBase	Yes	Callback interface
gid	String	Yes	Group ID
uid	Sting	No	User ID

Return Result

Code Example

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

            }

            @Override
            public void onSuccess(String data) {

            }
        }, gid,  uid);

uni-app

Function Prototype

IMSDK.transferGroupOwner({
  groupID: string;
  newOwnerUserID: string;
}, operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
newOwnerUserID	string	Yes	New owner user 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.transferGroupOwner({
  groupID: '',
  newOwnerUserID: '',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('transferGroupOwner', operationID: string, {
  groupID: string;
  newOwnerUserID: 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
newOwnerUserID	string	Yes	New owner user 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('transferGroupOwner', IMSDK.uuid(), {
  groupID: '',
  newOwnerUserID: '',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

OpenIMSDK.transferGroupOwner({
  groupID: string,
  newOwnerUserID: string,
}, operationID?: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
newOwnerUserID	string	Yes	New owner user 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.transferGroupOwner({
  groupID: '',
  newOwnerUserID: '',
})
  .then(() => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase	Yes	Callback interface
groupId	string	Yes	Group ID
newOwnerUserId	sting	No	User ID

Return Result

Code Example

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

}, groupId,  newOwnerUserId);