tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Real-Time Communication
    Documentation
    Download PDF

    TUIConferenceListManager

    Last updated: 2024-09-24 17:31:07
    Download PDF
      Copyright (c) 2024 Tencent. All rights reserved.
      Module: TUIConferenceListManager @ TUIKitEngine
      Function: ConferenceList APIS.
      
      TUIConferenceListManager

      TUIConferenceListManagerObserver

      FuncList
      DESC
      Callback for conference scheduled.
      Callback for conference will start.
      Callback for conference cancellation.
      Callback for conference information change.
      Callback for attendees change in the conference.
      Callback for conference status change.

      TUIConferenceListManager

      FuncList
      DESC
      Add event callback.
      Remove event callback.
      Schedule a conference.
      Cancel a scheduled conference.
      Update scheduled conference information.
      Fetch a list of scheduled conference.
      Fetch a list of attendees invited to the scheduled conference.
      Add attendees to the attendee list.
      Remove attendees from the attendee list.

      StructType

      FuncList
      DESC
      Conference information

      EnumType

      EnumType
      DESC
      Conference cancel reason.

      onConferenceScheduled:

      onConferenceScheduled:
      - (void)onConferenceScheduled:
      (TUIConferenceInfo *)conferenceInfo

      Callback for conference scheduled.

      Param
      DESC
      conferenceInfo
      Conference information.

      onConferenceWillStart:

      onConferenceWillStart:
      - (void)onConferenceWillStart:
      (TUIConferenceInfo *)conferenceInfo

      Callback for conference will start.

      Param
      DESC
      conferenceInfo
      Conference information.

      onConferenceCancelled:reason:operateUser:

      onConferenceCancelled:reason:operateUser:
      - (void)onConferenceCancelled:
      (NSString *)roomId
      reason:
      operateUser:
      (TUIUserInfo *) operateUser

      Callback for conference cancellation.

      Param
      DESC
      operateUser
      Information about the operator who cancelled the conference.
      reason
      The reason for the cancellation of the conference.
      roomId
      Conference ID, which is the room ID.

      onConferenceInfoChanged:modifyFlag:

      onConferenceInfoChanged:modifyFlag:
      - (void)onConferenceInfoChanged:
      (TUIConferenceInfo *)conferenceInfo
      modifyFlag:
      (TUIConferenceModifyFlag) modifyFlag

      Callback for conference information change.

      Param
      DESC
      conferenceInfo
      Conference information.
      modifyFlag
      Flag for conference information change.

      onScheduleAttendeesChanged:leftUsers:joinedUsers:

      onScheduleAttendeesChanged:leftUsers:joinedUsers:
      - (void)onScheduleAttendeesChanged:
      (NSString *)roomId
      leftUsers:
      (NSArray<TUIUserInfo *> *) leftUsers
      joinedUsers:
      (NSArray<TUIUserInfo *> *) joinedUsers

      Callback for attendees change in the conference.

      Param
      DESC
      joinedUsers
      The list of attendees who have joined.
      leftUsers
      The list of attendees who have left.
      roomId
      Conference ID, which is the room ID.

      onConferenceStatusChanged:status:

      onConferenceStatusChanged:status:
      - (void)onConferenceStatusChanged:
      (NSString *)roomId
      status:
      (TUIConferenceStatus) status

      Callback for conference status change.

      Param
      DESC
      roomId
      Conference ID, which is the room ID.
      status
      Conference status, see TUIConferenceStatus.

      addObserver:

      addObserver:
      - (void)addObserver:

      Add event callback.

      Param
      DESC
      observer
      The instance being listened to.

      removeObserver:

      removeObserver:
      - (void)removeObserver:

      Remove event callback.

      Param
      DESC
      observer
      The instance being listened to.

      scheduleConference:onSuccess:onError:

      scheduleConference:onSuccess:onError:
      - (void)scheduleConference:
      (TUIConferenceInfo *)conferenceInfo
      onSuccess:
      (TUISuccessBlock)onSuccess
      onError:
      (TUIErrorBlock)onError

      Schedule a conference.

      Param
      DESC
      conferenceInfo
      Information for conference.

      cancelConference:onSuccess:onError:

      cancelConference:onSuccess:onError:
      - (void)cancelConference:
      (NSString *)roomId
      onSuccess:
      (TUISuccessBlock)onSuccess
      onError:
      (TUIErrorBlock)onError

      Cancel a scheduled conference.

      Param
      DESC
      roomId
      The conference ID, which is the room ID, to cancel the conference.

      updateConferenceInfo:modifyFlag:onSuccess:onError:

      updateConferenceInfo:modifyFlag:onSuccess:onError:
      - (void)updateConferenceInfo:
      (TUIConferenceInfo *)conferenceInfo
      modifyFlag:
      (TUIConferenceModifyFlag) modifyFlag
      onSuccess:
      (TUISuccessBlock)onSuccess
      onError:
      (TUIErrorBlock)onError

      Update scheduled conference information.

      Param
      DESC
      conferenceInfo
      Information of scheduled conference.
      modifyFlag
      The flag used to update conference information.

      fetchScheduledConferenceList:cursor:count:onSuccess:onError:

      fetchScheduledConferenceList:cursor:count:onSuccess:onError:
      - (void)fetchScheduledConferenceList:
      (TUIConferenceStatus) status
      cursor:
      (NSString*) cursor
      count:
      (NSInteger) count
      onSuccess:
      (TUIScheduledConferenceListResponseBlock)onSuccess
      onError:
      (TUIErrorBlock)onError

      Fetch a list of scheduled conference.

      Param
      DESC
      count
      The number of conference to fetch this time.
      cursor
      Pagination index retrieval. For the first fetch, use an empty string. If the callback returns data with a non-empty cursor, it indicates that pagination is needed. Please call the interface again using the returned cursor as the parameter until the cursor returned is empty, indicating that all data has been fetched.
      status
      Conference status.

      fetchAttendeeList:cursor:count:onSuccess:onError:

      fetchAttendeeList:cursor:count:onSuccess:onError:
      - (void)fetchAttendeeList:
      (NSString *) roomId
      cursor:
      (NSString*) cursor
      count:
      (NSInteger) count
      onSuccess:
      (TUIScheduledAttendeesResponseBlock)onSuccess
      onError:
      (TUIErrorBlock)onError

      Fetch a list of attendees invited to the scheduled conference.

      Param
      DESC
      count
      The number of attendee to fetch this time.
      cursor
      Pagination index retrieval. For the first fetch, use an empty string. If the callback returns data with a non-empty cursor, it indicates that pagination is needed. Please call the interface again using the returned cursor as the parameter until the cursor returned is empty, indicating that all data has been fetched.
      roomId
      The conference ID, which is the room ID.

      addAttendeesByAdmin:userIdList:onSuccess:onError:

      addAttendeesByAdmin:userIdList:onSuccess:onError:
      - (void)addAttendeesByAdmin:
      (NSString *)roomId
      userIdList:
      (NSArray<NSString *> *)userIdList
      onSuccess:
      (TUISuccessBlock)onSuccess
      onError:
      (TUIErrorBlock)onError

      Add attendees to the attendee list.

      Param
      DESC
      roomId
      The conference ID, which is the room ID.
      userIdList
      List of attendee IDs.

      removeAttendeesByAdmin:userIdList:onSuccess:onError:

      removeAttendeesByAdmin:userIdList:onSuccess:onError:
      - (void)removeAttendeesByAdmin:
      (NSString *)roomId
      userIdList:
      (NSArray<NSString *> *)userIdList
      onSuccess:
      (TUISuccessBlock)onSuccess
      onError:
      (TUIErrorBlock)onError

      Remove attendees from the attendee list.

      Param
      DESC
      roomId
      The conference ID, which is the room ID.
      userIdList
      List of attendee IDs.

      TUIConferenceCancelReason

      TUIConferenceCancelReason

      Conference cancel reason.

      Enum
      Value
      DESC
      TUIConferenceCancelReasonCancelledByAdmin
      0
      The conference has been cancelled by the admin.
      TUIConferenceCancelReasonRemovedFromAttendees
      1
      The current user is removed from the attendee list.

      TUIConferenceInfo

      TUIConferenceInfo

      Conference information

      EnumType
      DESC
      basicRoomInfo
      Conference basic information .
      reminderSecondsBeforeStart
      Reminder time before conference start (seconds).
      scheduleAttendees
      The list of attendees can be set when schedule a conference. Use the fetchAttendeeList interface if you need to fetch attendees.
      scheduleEndTime
      Conference schedule end time.
      scheduleStartTime
      Conference schedule start time.
      status
      Conference status (readonly).
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy