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:
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.
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.
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.
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.
The Transfer Ownership component is composed of the following BaseComponents:
CometChatGroupMembers is an independent component designed to create a user-friendly screen for browsing and managing group members. Users can effortlessly search for specific members and take actions such as kicking, banning, or changing member scopes directly from the interface.
CometChatTransferOwnership, as a custom view controller, offers flexible integration options, allowing it to be launched directly via button clicks or any user-triggered action. Additionally, it seamlessly integrates into tab view controllers. With banned members, users gain access to a wide range of parameters and methods for effortless customization of its user interface.The following code snippet exemplifies how you can seamlessly integrate the TransferOwnership component into your application.
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. SetOnTransferOwnership
The setOnTransferOwnership 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.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your-uid", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group).setOnTransferOwnership { group, groupMember in//Perform Your Action}
2. SetOnItemClick
This method proves valuable when users seek to override onItemClick functionality within CometChatTransferOwnership, empowering them with greater control and customization options.The setOnItemClick action doesn’t have a predefined behavior. You can override this action using the following code snippet.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your UID", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group).setOnItemClick { groupMember, indexPath in//Perform Your Action}
3. SetOnItemLongClick
This method becomes invaluable when users seek to override long-click functionality within CometChatTransferOwnership, offering them enhanced control and flexibility in their interactions.The setOnItemLongClick action doesn’t have a predefined behavior. You can override this action using the following code snippet.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your UID", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group).setOnItemLongClick { groupMember, indexPath in//Perform Your Action}
4. SetOnError
You can customize this behavior by using the provided code snippet to override the On Error and improve error handling.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your UID", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group) .setOnError { error in //Perform Your Action}
5. SetOnBack
Enhance your application’s functionality by leveraging the SetOnBack feature. This capability allows you to customize the behavior associated with navigating back within your app. Utilize the provided code snippet to override default behaviors and tailor the user experience according to your specific requirements.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your UID", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group) .setOnBack { //Perform Your Action}
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 Chat SDK.
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
Methods
Type
Description
setLimit
Int
sets the number of banned members that can be fetched in a single request, suitable for pagination
setSearchKeyword
String
used for fetching banned members matching the passed string
setScope
[String]
used for fetching group members based on multiple scopes
ExampleIn the example below, we are applying a filter to the Group Members by setting the limit to 1 and setting the scope to show only admin.
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
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 Join Group component is as follows.
Event
Description
onOwnershipChange
Triggers when the ownership of a group member is changed successfully
Add Listener
Report incorrect code
Copy
Ask AI
// View controller from your project where you want to listen events.public class ViewController: UIViewController { public override func viewDidLoad() { super.viewDidLoad() // Subscribing for the listener to listen events from user module CometChatGroupEvents.addListener("UNIQUE_ID", self as CometChatGroupEventListener) }} // Listener events from groups moduleextension ViewController: CometChatGroupEventListener { public func onOwnershipChange(group: Group?, member: GroupMember?) { // Do Stuff }}
Emitting Group Events
Report incorrect code
Copy
Ask AI
///emit this when ownership is changed by logged in user.CometChatGroupEvents.emitOnGroupMemberChangeScope(updatedBy: User , updatedUser: User , scopeChangedTo: CometChat.MemberScope , scopeChangedFrom: CometChat.MemberScope, group: Group)
Remove Listener
View controller
Report incorrect code
Copy
Ask AI
public override func viewWillDisappear(_ animated: Bool) { // Uncubscribing for the listener to listen events from user moduleCometChatGroupEvents.removeListener("LISTENER_ID_USED_FOR_ADDING_THIS_LISTENER")}
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.
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.
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
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
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
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
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.
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.
Utilize this property to assign a custom ListItem to the TransferOwnership Component, allowing for enhanced customization and flexibility in its rendering.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your-uid", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group) .setListItemView { groupMember in //Perform Your Action}
Example
In this example, we will create a UIView file CustomListItemGroupView and pass it inside the setListItemView() method.
CustomListItemGroupView
Report incorrect code
Copy
Ask AI
import UIKitimport CometChatSDKimport CometChatUIKitSwiftclass CustomListItemGroupView: UIView { // Initialize your subviews let titleLabel: UILabel = { let label = UILabel() label.translatesAutoresizingMaskIntoConstraints = false label.font = UIFont.boldSystemFont(ofSize: 16) return label }() let statusIndicator: UIView = { let view = UIView() view.translatesAutoresizingMaskIntoConstraints = false view.backgroundColor = .systemRed view.layer.cornerRadius = 5 return view }() let groupImageView: CometChatAvatar = { let imageView = CometChatAvatar(frame: .zero) imageView.translatesAutoresizingMaskIntoConstraints = false return imageView }() // Override the initializer override init(frame: CGRect) { super.init(frame: frame) // Add subviews and layout constraints addSubview(groupImageView) addSubview(titleLabel) addSubview(statusIndicator) NSLayoutConstraint.activate([ groupImageView.leadingAnchor.constraint(equalTo: leadingAnchor, constant: 8), groupImageView.centerYAnchor.constraint(equalTo: centerYAnchor), groupImageView.heightAnchor.constraint(equalToConstant: 40), groupImageView.widthAnchor.constraint(equalToConstant: 40), titleLabel.centerYAnchor.constraint(equalTo: centerYAnchor), titleLabel.leadingAnchor.constraint(equalTo: groupImageView.trailingAnchor, constant: 8), titleLabel.trailingAnchor.constraint(equalTo: trailingAnchor, constant: -8), statusIndicator.widthAnchor.constraint(equalToConstant: 10), statusIndicator.heightAnchor.constraint(equalToConstant: 10), statusIndicator.trailingAnchor.constraint(equalTo: titleLabel.trailingAnchor), statusIndicator.bottomAnchor.constraint(equalTo: titleLabel.bottomAnchor) ]) } required init?(coder: NSCoder) { fatalError("init(coder:) has not been implemented") } func configure(with user: User) { titleLabel.text = user.name if let avatarUrl = user.avatar { groupImageView.setAvatar(avatarUrl: avatarUrl, with: user.name ?? "") } else { // handle when avatar is nil } }}
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your-uid", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group) .setListItemView { user in let customListItemGroupView = CustomListItemGroupView() customListItemGroupView.configure(with: user!) return customListItemGroupView}
Ensure to pass and present CometChatTransferOwnership. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.
You can set your custom Subtitle view using the .setSubtitleView() method. But keep in mind, by using this you will override the default Subtitle view functionality.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your-uid", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group) .setSubtitleView { groupMember in //Perform Your Action}
You can customize the subtitle view for each TransferOwnership item to meet your requirements
Example
In this example, we will create a Custom_Subtitle_GroupMember_Viewa UIView file.
We will be passing a custom subtitle view to CometChatTransferOwnership, ensuring a tailored and user-friendly interface.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your-uid", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group) .setSubtitleView { user in let customSubtitleGroupMemberView = CustomSubtitleGroupMemberView() customSubtitleGroupMemberView.configure(with: user!) return customSubtitleGroupMemberView}
Ensure to pass and present CometChatTransferOwnership. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.
Ensure to pass and present CometChatTransferOwnership. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.
Ensure to pass and present CometChatTransferOwnership. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.
You can set the Custom Menus to add more options to the TransferOwnership component.
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your-uid", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group).set(menus: [UIBarButtonItem])
You can customize the menus for TransferOwnership to meet your requirements
Example
In this example, we’ll craft a custom button tailored for CometChatTransferOwnership, enhancing its interface with a personalized menu for a more user-friendly experience.
Ensure to pass and present CometChatTransferOwnership. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.
Enhance your TransferOwnership component by setting Custom Options to incorporate additional functionalities when swiping
Swift
Report incorrect code
Copy
Ask AI
let group = Group(guid: "your-uid", name: "", groupType: .public, password: .none)let cometChatTransferOwnership = CometChatTransferOwnership(group: group) .setOptions { group, groupMember in //Perform Your Action}
You can customize the options for TransferOwnership to meet your requirements
Example
In this example, we’ve enhanced the interface of CometChatTransferOwnership by introducing a tailored feature. By adding a custom option, such as “Delete” with a corresponding trash icon, users can now enjoy a more interactive and user-friendly experience.
Ensure to pass and present CometChatTransferOwnership. If a navigation controller is already in use, utilize the pushViewController function instead of directly presenting the view controller.
Ensure to include your GUID and the name of your group when configuring group settings.