TenantManager class

A Tenant is the streaming platform which is using Spect8 SDK.

All the operations that are to be carried out across the tenant can be performed using a tenant manager.

Each tenant manager has a unique id.

Constructors

TenantManager({required String tenantId})
The constructor used to fetch the TenantManager object It is intended to be called/used only on authentication

Properties

config ClientConfig
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
tenantId String
final
webSocket Spect8TenantWebSocket
getter/setter pair

Methods

createBroadcast({required String broadcastName}) Future<Broadcast>
Creates and Returns a Broadcast having the broadcastName
createDisclaimer({required String disclaimer, required String link}) Future<void>
Creates a new Disclaimer
createReport({required String reportedUserId, required String type, required String text}) Future<void>
Reports a user
getAdManager({required String adId}) AdManager
Returns an instance of AdManager which can be used for operations related to a specific ad having a unique id known as adId
getAllAds() Future<Ads>
Returns Ads available against tenant
getAllBroadcasts() Future<List<Broadcast>>
Returns the List of all Broadcast available against tenant
getAllChannels() Future<List<Channel>>
Returns the List of all Channel available against tenant
getAllDisclaimers() Future<List<Disclaimer>>
Returns the List of Disclaimer available against tenant
getAllEventDays() Future<List<EventDay>>
Returns the List of EventDay available against tenant
getAllPinnedMessages() Future<List<PinnedMessage>>
Returns the List of PinnedMessage available against tenant
getAllShopCategories() Future<List<ShopCategory>>
Returns the List of ShopCategory available against tenant
getBroadcast({required String broadcastName}) Future<Broadcast>
Returns the Broadcast which has the name broadcastName
getBroadcastManager({required String broadcastId}) BroadcastManager
Returns an instance of BroadcastManager which can be used for operations related to a specific broadcast having a unique id known as broadcastId
getCurrentUserManager() CurrentUserManager
Returns an instance of CurrentUserManager which can be used for operations related to the current user
getDefaultTabInfo() Future<List<Spect8Tab>>
Returns the default List of navigation Tab available against tenant
getDisclaimerManager({required String disclaimerId}) DisclaimerManager
Returns an instance of DisclaimerManager which can be used for operations related to a specific disclaimer having a unique id known as disclaimerId
getEventDay({required String eventDayId}) Future<EventDay>
Returns the EventDay having a unique id known as eventDayId
getFileArchives() Future<List<FileArchive>>
Returns an List of FileArchive
getReportManager({required String reportId}) ReportManager
Returns an instance of ReportManager which can be used for operations related to a specific report having a unique id known as reportId
getShopCategoryManager({required String categoryId}) ShopCategoryManager
Returns an instance of ShopCategoryManager which can be used for operations related to a specific category having a unique id known as categoryId
getThemeConfiguration() Future<ThemeConfigData>
Returns the Theme ThemeConfigData
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
subscribe(dynamic subscriptionFunction(Spect8Event)) → void
Subscribes to the tenant wide messages socket,
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited