Skip to main content
Version: v4

Transfer Ownership

Overview​

CometChatTransferOwnership is a Component that allows the current owner or administrator of a group to transfer the ownership rights and administrative control of that group to another user. By transferring ownership, the original owner can designate a new user as the group owner, giving them full control and administrative privileges over the group.

Here are some key points regarding the transfer ownership feature in CometChat:

  1. Administrative Control: The current owner or administrator of the group has the authority to initiate the transfer of ownership. This feature is typically available to ensure flexibility and allow smooth transitions of group ownership.
  2. New Group Owner: During the transfer process, the current owner can select a specific user from the group members to become the new owner. This new owner will then assume the responsibilities and privileges associated with being the group owner.
  3. Administrative Privileges: As the new owner, the designated user will gain full administrative control over the group. They will have the ability to manage group settings, add or remove members, moderate conversations, and perform other administrative actions.
  4. Group Continuity: Transferring ownership does not disrupt the existing group or its content. The transfer ensures the continuity of the group while transferring the administrative control to a new owner.
Image

The Transfer Ownership component is composed of the following BaseComponents:

ComponentsDescription
cometchat-buttonThis component represents a button with optional icon and text.
cometchat-labelThis component provides descriptive information about the associated UI element.
cometchat-radio-buttonThis component allows the user to exactly select one item from a set

Usage​

Integration​

The following code snippet illustrates how you can directly incorporate the Transfer Ownership component into your Application.


import { CometChat } from '@cometchat/chat-sdk-javascript';
import { CometChatTransferOwnership } from '@cometchat/chat-uikit-react'
import React from 'react'

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group | undefined>();

  React.useEffect(() => {
    CometChat.getGroup("guid").then((group) => {
      setChatGroup(group);
    })
  }, []);



  return (
    <>
      {
        chatGroup &&
        <CometChatTransferOwnership
          group={chatGroup}

        />
      }
    </>
  )
}

export default TransferOwnerShipDemo;

Actions​

Actions dictate how a component functions. They are divided into two types: Predefined and User-defined. You can override either type, allowing you to tailor the behavior of the component to fit your specific needs.

1. onTransferOwnership​

The onTransferOwnership action is activated when you select a group member and click on the transfer ownership submit button. you have the flexibility to override this event and tailor it to suit your needs using the following code snippet.

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("GUID").then((group) => {
      setChatGroup(group);
    });
  }, []);

  function handleOnTransferOwnerShip(groupMember: CometChat.GroupMember): void {
    console.log(groupMember);
    //your custom handle on transfer-ownership actions
  }

  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          onTransferOwnership={handleOnTransferOwnerShip}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;
2. onClose​

onClose is triggered when you click on the close button of the Transfer Ownership component. You can override this action using the following code snippet.

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("GUID").then((group) => {
      setChatGroup(group);
    });
  }, []);

  function handleOnClose(): void {
    //Your Custom On Close Actions
  }

  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership group={chatGroup} onClose={handleOnClose} />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;
3. onError​

This action doesn't change the behavior of the component but rather listens for any errors that occur in the Transfer Ownership component.

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("GUID").then((group) => {
      setChatGroup(group);
    });
  }, []);

  function handleOnError(error: CometChat.CometChatException): void {
    //your custom on error actions
  }

  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership group={chatGroup} onError={handleOnError} />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

Filters​

Filters allow you to customize the data displayed in a list within a Component. You can filter the list based on your specific criteria, allowing for a more customized. Filters can be applied using RequestBuilders of ChatSDK.

1. GroupMembersRequestBuilder​

The GroupMembersRequestBuilder enables you to filter and customize the group members list based on available parameters in GroupMembersRequestBuilder. This feature allows you to create more specific and targeted queries when fetching groups. The following are the parameters available in GroupMembersRequestBuilder

MethodsTypeDescription
setLimitnumbersets the number of group members that can be fetched in a single request, suitable for pagination
setSearchKeywordStringused for fetching group members matching the passed string
setScopesArray<String>used for fetching group members based on multiple scopes

Example

In the example below, we are applying a filter to the Group Members by setting the limit to 3 and setting the scope to show only admin.

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          groupMemberRequestBuilder={new CometChat.GroupMembersRequestBuilder(
            "guid"
          )
            .setLimit(3)
            .setScopes(["admin"])}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;
2. SearchRequestBuilder​

The SearchRequestBuilder uses GroupMembersRequestBuilder enables you to filter and customize the search list based on available parameters in GroupMembersRequestBuilder. This feature allows you to keep uniformity between the displayed Group Members List and searched Group Members List.

Example

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          searchRequestBuilder={new CometChat.GroupMembersRequestBuilder("uid")
            .setLimit(2)
            .setSearchKeyword("**")}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

Events​

Events are emitted by a Component. By using event you can extend existing functionality. Being global events, they can be applied in Multiple Locations and are capable of being Added or Removed.

Events emitted by the Transfer Ownership component is as follows.

EventDescription
ccOwnershipChangedTriggers when the ownership of a group member is changed successfully
const ccOwnershipChanged = CometChatGroupEvents.ccOwnershipChanged.subscribe(
  (item: IOwnershipChanged) => {
    //Your Code
  }
);
ccOwnershipChanged?.unsubscribe();

Customization​

To fit your app's design requirements, you can customize the appearance of the Transfer Ownership component. We provide exposed methods that allow you to modify the experience and behavior according to your specific needs.

Style​

Using Style you can customize the look and feel of the component in your app, These parameters typically control elements such as the color, size, shape, and fonts used within the component.

1. TransferOwnership Style​

You can set the TransferOwnershipStyle to the Transfer Ownership Component to customize the styling.

Image
TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatTransferOwnership,
  TransferOwnershipStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const transferOwnershipStyle = new TransferOwnershipStyle({
    background: "#e9c4ff",
    MemberScopeTextColor: "#ffffff",
    transferButtonTextColor: "#ffffff",
    MemberScopeTextFont: "#ffffff",
    cancelButtonTextColor: "#ffffff",
  });
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          transferOwnershipStyle={transferOwnershipStyle}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

List of properties exposed by TransferOwnershipStyle:

PropertyDescriptionCode
borderUsed to set borderborder?: string,
borderRadiusUsed to set border radiusborderRadius?: string;
backgroundUsed to set background colourbackground?: string;
heightUsed to set heightheight?: string;
widthUsed to set widthwidth?: string;
MemberScopeTextColorUsed to set member scope text colorMemberScopeTextColor?: string,
MemberScopeTextFontUsed to set member scope text fontMemberScopeTextFont?: string;
transferButtonTextFontUsed to set transfer button text fonttransferButtonTextFont?: string;
transferButtonTextColorUsed to set transfer button text colortransferButtonTextColor?: string;
cancelButtonTextFontUsed to set cancel button text fontcancelButtonTextFont?: string;
cancelButtonTextColorUsed to set cancel button text colorcancelButtonTextColor?: string;
2. Avatar Style​

To apply customized styles to the Avatar component in the Transfer Ownership Component, you can use the following code snippet. For further insights on Avatar Styles refer

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatTransferOwnership,
  AvatarStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const avatarStyle = new AvatarStyle({
    backgroundColor: "#cdc2ff",
    border: "2px solid #6745ff",
    borderRadius: "10px",
    outerViewBorderColor: "#ca45ff",
    outerViewBorderRadius: "5px",
    nameTextColor: "#4554ff",
  });
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          avatarStyle={avatarStyle}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;
3. GroupMembers Style​

You can set the GroupMembersStyle to the Transfer Ownership Component to customize the styling, you can use the following code snippet. For further insights on GroupMembers Styles refer

Image
TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatTransferOwnership,
  GroupMembersStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const groupMembersStyle = new GroupMembersStyle({
    background: "#b17efc",
    searchPlaceholderTextColor: "#ffffff",
    titleTextColor: "#000000",
    searchBackground: "#5718b5",
  });
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          groupMembersStyle={groupMembersStyle}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;
4. ListItem Style​

To apply customized styles to the ListItemStyle component in the Transfer Ownership Component, you can use the following code snippet. For further insights on ListItemStyle Styles refer

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatTransferOwnership,
  ListItemStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const listItemStyle = new ListItemStyle({
    width: "100%",
    height: "100%",
    border: "2px solid red",
  });
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          listItemStyle={listItemStyle}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;
5. StatusIndicator Style​

To apply customized styles to the Status Indicator component in the Transfer Ownership Component, You can use the following code snippet. For further insights on Status Indicator Styles refer

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const statusIndicatorStyle = {
    background: "#db35de",
    height: "10px",
    width: "10px",
  };
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          statusIndicatorStyle={statusIndicatorStyle}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

Functionality​

These are a set of small functional customizations that allow you to fine-tune the overall experience of the component. With these, you can change text, set custom icons, and toggle the visibility of UI elements.

TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<CometChat.Group>();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          title="Your Custom Title"
          cancelButtonText="Your Custom Cancel Button Text"
          hideSeparator={true}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

Default:

Image

Custom:

Image

Below is a list of customizations along with corresponding code snippets

PropertyDescriptionCode
title report Used to set title in the app headingtitle="Your Custom Title"
cancelButtonText report Used to set the cancel button textcancelButtonText="Your Custom cancel button text"
transferButtonText report Used to set the transfer button texttransferButtonText="Your Custom transfer button text"
errorStateText report Used to set a custom text response when some error occurs on fetching the list of group memberserrorStateText="your custom error state text"
emptyStateText report Used to set a custom text response when fetching the group members has returned an empty listemptyStateText="your custom empty state text"
searchPlaceholder report Used to set custom search placeholder textsearchPlaceholder='Custom Search PlaceHolder'
searchIconURLUsed to set search Icon in the search fieldsearchIconURL="Your Custom search icon"
loadingIconURLUsed to set loading IconloadingIconURL="your custom loading icon url"
closeButtonIconURLUsed to set close button IconcloseButtonIconURL="your custom close icon url"
hideSearchUsed to toggle visibility for search boxhideSearch={true}"
hideSeparatorUsed to hide the divider separating the user itemshideSeparator={true}
disableUsersPresenceUsed to toggle functionality to show user's presencedisableUsersPresence={true}
titleAlignmentAlignment of the heading text for the componenttitleAlignment={TitleAlignment.center}
group report Used to pass group object of which group members will be showngroup={chatGroup}

Advance​

For advanced-level customization, you can set custom views to the component. This lets you tailor each aspect of the component to fit your exact needs and application aesthetics. You can create and define your views, layouts, and UI elements and then incorporate those into the component.

ListItemView​

With this property, you can assign a custom ListItem to the Transfer Ownership Component.

listItemView = { getListItemView };

Example

Default:

Image

Custom:

Image
TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const getListItemView = (groupMembers: CometChat.GroupMember) => {
    return (
      <div
        style={{
          display: "flex",
          alignItems: "left",
          padding: "10px",
          border: "2px solid #e9baff",
          borderRadius: "20px",
          background: "#6e2bd9",
        }}
      >
        <cometchat-avatar
          image={groupMembers.getAvatar()}
          name={groupMembers.getName()}
        />

        <div style={{ display: "flex", paddingLeft: "10px" }}>
          <div
            style={{ fontWeight: "bold", color: "#ffffff", fontSize: "14px" }}
          >
            {groupMembers.getName()}
            <div
              style={{ color: "#ffffff", fontSize: "10px", textAlign: "left" }}
            >
              {groupMembers.getStatus()}
            </div>
          </div>
        </div>
      </div>
    );
  };
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          listItemView={getListItemView}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

SubtitleView​

You can customize the subtitle view for each Transfer Ownership to meet your requirements

subtitleView = { getSubtitleView };

Default:

Image

Custom:

Image
TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const getSubtitleView = (
    groupMembers: CometChat.GroupMember
  ): JSX.Element => {
    function formatTime(timestamp: number) {
      const date = new Date(timestamp * 1000);
      return date.toLocaleString();
    }
    if (groupMembers instanceof CometChat.GroupMember) {
      return (
        <div
          style={{
            display: "flex",
            alignItems: "left",
            padding: "2px",
            fontSize: "10px",
          }}
        >
          <div style={{ color: "gray" }}>
            Last Active At: {formatTime(groupMembers.getLastActiveAt())}
          </div>
        </div>
      );
    } else {
      return <></>;
    }
  };
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          subtitleView={getSubtitleView}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

LoadingStateView​

You can set a custom loader view using loadingStateView to match the loading view of your app.

loadingStateView={getLoadingStateView()}

Default:

Image

Custom:

Image
TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import {
  CometChatTransferOwnership,
  LoaderStyle,
} from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const getLoadingStateView = () => {
    const getLoaderStyle = new LoaderStyle({
      iconTint: "#890aff",
      background: "transparent",
      height: "100vh",
      width: "100vw",
    });

    return (
      <cometchat-loader
        iconURL="icon"
        loaderStyle={JSON.stringify(getLoaderStyle)}
      ></cometchat-loader>
    );
  };
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          loadingStateView={getLoadingStateView()}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

EmptyStateView​

You can set a custom EmptyStateView using emptyStateView to match the empty view of your app.

emptyStateView={getEmptyStateView()}

Default:

Image

Custom:

Image
TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const getEmptyStateView = () => {
    return (
      <div style={{ color: "#d6cfff", fontSize: "30px", font: "bold" }}>
        Your Custom Empty State
      </div>
    );
  };
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          emptyStateView={getEmptyStateView()}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;

ErrorStateView​

You can set a custom ErrorStateView using errorStateView to match the error view of your app.

errorSateView={getErrorStateView()}

Default:

Image

Custom:

Image
TransferOwnerShipDemo.tsx
import { CometChat } from "@cometchat/chat-sdk-javascript";
import { CometChatTransferOwnership } from "@cometchat/chat-uikit-react";
import React from "react";

const TransferOwnerShipDemo = () => {
  const [chatGroup, setChatGroup] = React.useState<
    CometChat.Group | undefined
  >();

  React.useEffect(() => {
    CometChat.getGroup("uid").then((group) => {
      setChatGroup(group);
    });
  }, []);
  const getErrorStateView = () => {
    return (
      <div style={{ height: "100vh", width: "100vw" }}>
        <img
          src="image"
          alt="error icon"
          style={{
            height: "100px",
            width: "100px",
            marginTop: "250px",
            justifyContent: "center",
          }}
        ></img>
      </div>
    );
  };
  return (
    <>
      {chatGroup && (
        <CometChatTransferOwnership
          group={chatGroup}
          errorStateView={getErrorStateView()}
        />
      )}
    </>
  );
};

export default TransferOwnerShipDemo;