IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMTopicInfo

Public Member Functions

 V2TIMTopicInfo ()
 
String getTopicID ()
 
void setTopicID (String topicID)
 
String getTopicType ()
 
void setTopicType (String topicType)
 
String getTopicName ()
 
void setTopicName (String topicName)
 
String getTopicFaceUrl ()
 
void setTopicFaceUrl (String faceUrl)
 
String getIntroduction ()
 
void setIntroduction (String introduction)
 
String getNotification ()
 
void setNotification (String notification)
 
boolean isAllMute ()
 
void setAllMute (boolean allMute)
 
long getSelfMuteTime ()
 
String getCustomString ()
 
void setCustomString (String customString)
 
int getRecvOpt ()
 
String getDraftText ()
 
void setDraft (String draftText)
 
long getUnreadCount ()
 
V2TIMMessage getLastMessage ()
 
long getReadSequence ()
 
List< V2TIMGroupAtInfogetGroupAtInfoList ()
 
long getCreateTime ()
 
int getTopicAddOpt ()
 
void setTopicAddOpt (int groupAddOpt)
 
int getTopicApproveOpt ()
 
void setTopicApproveOpt (int approveOpt)
 
void setMemberList (List< V2TIMCreateGroupMemberInfo > memberList)
 
long getMemberMaxCount ()
 
void setMemberMaxCount (long memberMaxCount)
 
Long getDefaultPermissions ()
 
void setDefaultPermissions (long defaultPermissions)
 
boolean isInheritMessageReceiveOptionFromCommunity ()
 
void setInheritMessageReceiveOptionFromCommunity (boolean inheritMessageReceiveOptionFromCommunity, V2TIMCallback v2TIMCallback)
 

Static Public Attributes

static final int V2TIM_GROUP_ADD_FORBID = 0
 
static final int V2TIM_GROUP_ADD_AUTH = 1
 
static final int V2TIM_GROUP_ADD_ANY = 2
 

Constructor & Destructor Documentation

◆ V2TIMTopicInfo()

V2TIMTopicInfo ( )
inline

Member Function Documentation

◆ getTopicID()

String getTopicID ( )
inline

Get the topic ID

Returns
Topic ID

◆ setTopicID()

void setTopicID ( String  topicID)
inline

Set the topic ID. The topic ID can only be set when a topic is created or when the topic information is modified. The format is: community ID + @TOPIC_xxx. For example, if the community ID is @TGS_123, then the topic ID is @TGS_123@TOPIC_xxx.

Parameters
topicIDTopic ID

◆ getTopicType()

String getTopicType ( )
inline

Get topic type (supported only in 8.4 and later versions)

◆ setTopicType()

void setTopicType ( String  topicType)
inline

Set the topic type. This operation can be performed only during topic creation. Its default value is Public (supported only in 8.4 and later versions) "Public" :public topic, community members can send messages directly in the topic. "Private" :private topic, has its own member list (supports up to 10,000 members), community members need to join the topic before sending message (you need to buy Enterprise Edition to use this feature).

◆ getTopicName()

String getTopicName ( )
inline

Get the topic name

Returns
Topic Name

◆ setTopicName()

void setTopicName ( String  topicName)
inline

Set the topic name. This operation can be performed only during topic creation or topic information modification.

Attention
The maximum length of the topic name is 150 bytes, encoded in UTF-8.
Parameters
topicNameTopic name

◆ getTopicFaceUrl()

String getTopicFaceUrl ( )
inline

Get the topic profile photo URL

Returns
Topic profile photo URL

◆ setTopicFaceUrl()

void setTopicFaceUrl ( String  faceUrl)
inline

Set the topic profile photo URL

Attention
The maximum length of the URL is 500 bytes, encoded in UTF-8.
Parameters
faceUrlTopic profile photo URL

◆ getIntroduction()

String getIntroduction ( )
inline

Get the topic introduction

◆ setIntroduction()

void setIntroduction ( String  introduction)
inline

Set the topic introduction. This operation can be performed only during topic creation or topic information modification.

Attention
The maximum length of the introduction is 400 bytes, encoded in UTF-8.

◆ getNotification()

String getNotification ( )
inline

Get the topic notice.

◆ setNotification()

void setNotification ( String  notification)
inline

Set the topic notice. This operation can be performed only during topic creation or topic information modification.

Attention
The maximum length of the topic notification is 400 bytes, encoded in UTF-8.

◆ isAllMute()

boolean isAllMute ( )
inline

Get whether the current topic has muted all members

◆ setAllMute()

void setAllMute ( boolean  allMute)
inline

Set whether to mute all group members. This operation can be performed only during topic information modification.

◆ getSelfMuteTime()

long getSelfMuteTime ( )
inline

Get current user's mute time in the topic.

◆ getCustomString()

String getCustomString ( )
inline

Get the custom string

◆ setCustomString()

void setCustomString ( String  customString)
inline

Set the custom string

◆ getRecvOpt()

int getRecvOpt ( )
inline

Get the current user's message receiving option in the topic. To modify the topic message receiving option, please call the setReceiveMessageOpt API.

Returns
Message receiving options: V2TIMMessage.V2TIM_RECEIVE_MESSAGE, V2TIMMessage.V2TIM_NOT_RECEIVE_MESSAGE, V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE V2TIMMessage.V2TIM_RECEIVE_NOT_NOTIFY_MESSAGE_EXCEPT_AT

◆ getDraftText()

String getDraftText ( )
inline

Get the draft of a topic

Returns
The draft content. If the draft does not exist or an error occurs, null will be returned.

◆ setDraft()

void setDraft ( String  draftText)
inline

Set a draft for a topic

◆ getUnreadCount()

long getUnreadCount ( )
inline

Get the unread message count in the topic

◆ getLastMessage()

V2TIMMessage getLastMessage ( )
inline

Last message in the topic.

◆ getReadSequence()

long getReadSequence ( )
inline

Sequence of the latest message which has been read (supported only in 7.8 and later versions).

◆ getGroupAtInfoList()

List<V2TIMGroupAtInfo> getGroupAtInfoList ( )
inline

Get a list of @ messages in the topic

◆ getCreateTime()

long getCreateTime ( )
inline

Topic creation time.

◆ getTopicAddOpt()

int getTopicAddOpt ( )
inline

Get whether admin approval is required to join the group (supported only in 8.4 and later versions)

◆ setTopicAddOpt()

void setTopicAddOpt ( int  groupAddOpt)
inline

Set whether admin approval is required to join the topic (valid for private topics, no approval is required by default) (supported only in 8.4 and later versions)

◆ getTopicApproveOpt()

int getTopicApproveOpt ( )
inline

Get the approval method for inviting new topic members (supported only in 8.4 and later versions)

◆ setTopicApproveOpt()

void setTopicApproveOpt ( int  approveOpt)
inline

Set the approval method for inviting new topic members (valid for private topics, no approval is required by default) (supported only in 8.4 and later versions)

◆ setMemberList()

void setMemberList ( List< V2TIMCreateGroupMemberInfo memberList)
inline

Set topic default members (valid for private topics, supports up to 100 topic members, can only be set when creating topic) (supported only in 8.4 and later versions)

◆ getMemberMaxCount()

long getMemberMaxCount ( )
inline

Get the maximum number of topic members allowed to join (supported only in 8.4 and later versions)

◆ setMemberMaxCount()

void setMemberMaxCount ( long  memberMaxCount)
inline

Set the maximum number of topic members allowed to join (valid for private topics, supports up to 10000, default value is 10000, can only be set when creating topic) (supported only in 8.4 and later versions)

◆ getDefaultPermissions()

Long getDefaultPermissions ( )
inline

Get topic default permissions, supported only in 7.8 and later versions

◆ setDefaultPermissions()

void setDefaultPermissions ( long  defaultPermissions)
inline

Set topic default permissions, supported only in 7.8 and later versions

Attention
This API sets the default permissions for members who have not joined any permission groups. It takes effect only when permission groups are enabled (enablePermissionGroup in V2TIMGroupInfo is true).

◆ isInheritMessageReceiveOptionFromCommunity()

boolean isInheritMessageReceiveOptionFromCommunity ( )
inline

Get whether the message receiving option for the topic is inherited from its community. This feature is available only in SDK enhanced edition v8.1 or later.

◆ setInheritMessageReceiveOptionFromCommunity()

void setInheritMessageReceiveOptionFromCommunity ( boolean  inheritMessageReceiveOptionFromCommunity,
V2TIMCallback  v2TIMCallback 
)
inline

Set whether the message receiving option for the topic is inherited from its community. This feature is available only in SDK enhanced edition v8.1 or later.

Field Documentation

◆ V2TIM_GROUP_ADD_FORBID

final int V2TIM_GROUP_ADD_FORBID = 0
static

Forbid anyone to join the topic

◆ V2TIM_GROUP_ADD_AUTH

final int V2TIM_GROUP_ADD_AUTH = 1
static

Require admin approval

◆ V2TIM_GROUP_ADD_ANY

final int V2TIM_GROUP_ADD_ANY = 2
static

Anyone can join