PublicApi class

Constructors

PublicApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

blockFromCommentPublic(String tenantId, String commentId, PublicBlockFromCommentParams publicBlockFromCommentParams, [String? sso]) → Future<BlockSuccess?>
Parameters:
blockFromCommentPublicWithHttpInfo(String tenantId, String commentId, PublicBlockFromCommentParams publicBlockFromCommentParams, [String? sso]) → Future<Response>
Performs an HTTP 'POST /block-from-comment/{commentId}' operation and returns the Response. Parameters:
checkedCommentsForBlocked(String tenantId, String commentIds, [String? sso]) → Future<CheckBlockedCommentsResponse?>
Parameters:
checkedCommentsForBlockedWithHttpInfo(String tenantId, String commentIds, [String? sso]) → Future<Response>
Performs an HTTP 'GET /check-blocked-comments' operation and returns the Response. Parameters:
createCommentPublic(String tenantId, String urlId, String broadcastId, CommentData commentData, [CreateCommentPublicOptions? options]) → Future<SaveCommentsResponseWithPresence?>
Parameters:
createCommentPublicWithHttpInfo(String tenantId, String urlId, String broadcastId, CommentData commentData, [CreateCommentPublicOptions? options]) → Future<Response>
Performs an HTTP 'POST /comments/{tenantId}' operation and returns the Response. Parameters:
createFeedPostPublic(String tenantId, CreateFeedPostParams createFeedPostParams, [CreateFeedPostPublicOptions? options]) → Future<CreateFeedPostResponse?>
Parameters:
createFeedPostPublicWithHttpInfo(String tenantId, CreateFeedPostParams createFeedPostParams, [CreateFeedPostPublicOptions? options]) → Future<Response>
Performs an HTTP 'POST /feed-posts/{tenantId}' operation and returns the Response. Parameters:
createV1PageReact(String tenantId, String urlId, [String? title]) → Future<CreateV1PageReact?>
Parameters:
createV1PageReactWithHttpInfo(String tenantId, String urlId, [String? title]) → Future<Response>
Performs an HTTP 'POST /page-reacts/v1/likes/{tenantId}' operation and returns the Response. Parameters:
createV2PageReact(String tenantId, String urlId, String id, [String? title]) → Future<CreateV1PageReact?>
Parameters:
createV2PageReactWithHttpInfo(String tenantId, String urlId, String id, [String? title]) → Future<Response>
Performs an HTTP 'POST /page-reacts/v2/{tenantId}' operation and returns the Response. Parameters:
deleteCommentPublic(String tenantId, String commentId, String broadcastId, [DeleteCommentPublicOptions? options]) → Future<PublicAPIDeleteCommentResponse?>
Parameters:
deleteCommentPublicWithHttpInfo(String tenantId, String commentId, String broadcastId, [DeleteCommentPublicOptions? options]) → Future<Response>
Performs an HTTP 'DELETE /comments/{tenantId}/{commentId}' operation and returns the Response. Parameters:
deleteCommentVote(String tenantId, String commentId, String voteId, String urlId, String broadcastId, [DeleteCommentVoteOptions? options]) → Future<VoteDeleteResponse?>
Parameters:
deleteCommentVoteWithHttpInfo(String tenantId, String commentId, String voteId, String urlId, String broadcastId, [DeleteCommentVoteOptions? options]) → Future<Response>
Performs an HTTP 'DELETE /comments/{tenantId}/{commentId}/vote/{voteId}' operation and returns the Response. Parameters:
deleteFeedPostPublic(String tenantId, String postId, [DeleteFeedPostPublicOptions? options]) → Future<DeleteFeedPostPublicResponse?>
Parameters:
deleteFeedPostPublicWithHttpInfo(String tenantId, String postId, [DeleteFeedPostPublicOptions? options]) → Future<Response>
Performs an HTTP 'DELETE /feed-posts/{tenantId}/{postId}' operation and returns the Response. Parameters:
deleteV1PageReact(String tenantId, String urlId) → Future<CreateV1PageReact?>
Parameters:
deleteV1PageReactWithHttpInfo(String tenantId, String urlId) → Future<Response>
Performs an HTTP 'DELETE /page-reacts/v1/likes/{tenantId}' operation and returns the Response. Parameters:
deleteV2PageReact(String tenantId, String urlId, String id) → Future<CreateV1PageReact?>
Parameters:
deleteV2PageReactWithHttpInfo(String tenantId, String urlId, String id) → Future<Response>
Performs an HTTP 'DELETE /page-reacts/v2/{tenantId}' operation and returns the Response. Parameters:
flagCommentPublic(String tenantId, String commentId, bool isFlagged, [String? sso]) → Future<APIEmptyResponse?>
Parameters:
flagCommentPublicWithHttpInfo(String tenantId, String commentId, bool isFlagged, [String? sso]) → Future<Response>
Performs an HTTP 'POST /flag-comment/{commentId}' operation and returns the Response. Parameters:
getCommentsForUser([GetCommentsForUserOptions? options]) → Future<GetCommentsForUserResponse?>
Parameters:
getCommentsForUserWithHttpInfo([GetCommentsForUserOptions? options]) → Future<Response>
Performs an HTTP 'GET /comments-for-user' operation and returns the Response. Parameters:
getCommentsPublic(String tenantId, String urlId, [GetCommentsPublicOptions? options]) → Future<GetCommentsResponseWithPresencePublicComment?>
req tenantId urlId
getCommentsPublicWithHttpInfo(String tenantId, String urlId, [GetCommentsPublicOptions? options]) → Future<Response>
req tenantId urlId
getCommentText(String tenantId, String commentId, [GetCommentTextOptions? options]) → Future<PublicAPIGetCommentTextResponse?>
Parameters:
getCommentTextWithHttpInfo(String tenantId, String commentId, [GetCommentTextOptions? options]) → Future<Response>
Performs an HTTP 'GET /comments/{tenantId}/{commentId}/text' operation and returns the Response. Parameters:
getCommentVoteUserNames(String tenantId, String commentId, int dir, [String? sso]) → Future<GetCommentVoteUserNamesSuccessResponse?>
Parameters:
getCommentVoteUserNamesWithHttpInfo(String tenantId, String commentId, int dir, [String? sso]) → Future<Response>
Performs an HTTP 'GET /comments/{tenantId}/{commentId}/votes' operation and returns the Response. Parameters:
getEventLog(String tenantId, String urlId, String userIdWS, int startTime, [int? endTime]) → Future<GetEventLogResponse?>
req tenantId urlId userIdWS
getEventLogWithHttpInfo(String tenantId, String urlId, String userIdWS, int startTime, [int? endTime]) → Future<Response>
req tenantId urlId userIdWS
getFeedPostsPublic(String tenantId, [GetFeedPostsPublicOptions? options]) → Future<PublicFeedPostsResponse?>
req tenantId afterId
getFeedPostsPublicWithHttpInfo(String tenantId, [GetFeedPostsPublicOptions? options]) → Future<Response>
req tenantId afterId
getFeedPostsStats(String tenantId, List<String> postIds, [String? sso]) → Future<FeedPostsStatsResponse?>
Parameters:
getFeedPostsStatsWithHttpInfo(String tenantId, List<String> postIds, [String? sso]) → Future<Response>
Performs an HTTP 'GET /feed-posts/{tenantId}/stats' operation and returns the Response. Parameters:
getGifLarge(String tenantId, String largeInternalURLSanitized) → Future<GifGetLargeResponse?>
Parameters:
getGifLargeWithHttpInfo(String tenantId, String largeInternalURLSanitized) → Future<Response>
Performs an HTTP 'GET /gifs/get-large/{tenantId}' operation and returns the Response. Parameters:
getGifsSearch(String tenantId, String search, [GetGifsSearchOptions? options]) → Future<GetGifsSearchResponse?>
Parameters:
getGifsSearchWithHttpInfo(String tenantId, String search, [GetGifsSearchOptions? options]) → Future<Response>
Performs an HTTP 'GET /gifs/search/{tenantId}' operation and returns the Response. Parameters:
getGifsTrending(String tenantId, [GetGifsTrendingOptions? options]) → Future<GetGifsTrendingResponse?>
Parameters:
getGifsTrendingWithHttpInfo(String tenantId, [GetGifsTrendingOptions? options]) → Future<Response>
Performs an HTTP 'GET /gifs/trending/{tenantId}' operation and returns the Response. Parameters:
getGlobalEventLog(String tenantId, String urlId, String userIdWS, int startTime, [int? endTime]) → Future<GetEventLogResponse?>
req tenantId urlId userIdWS
getGlobalEventLogWithHttpInfo(String tenantId, String urlId, String userIdWS, int startTime, [int? endTime]) → Future<Response>
req tenantId urlId userIdWS
getOfflineUsers(String tenantId, String urlId, [GetOfflineUsersOptions? options]) → Future<PageUsersOfflineResponse?>
Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
getOfflineUsersWithHttpInfo(String tenantId, String urlId, [GetOfflineUsersOptions? options]) → Future<Response>
Past commenters on the page who are NOT currently online. Sorted by displayName. Use this after exhausting /users/online to render a "Members" section. Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
getOnlineUsers(String tenantId, String urlId, [GetOnlineUsersOptions? options]) → Future<PageUsersOnlineResponse?>
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
getOnlineUsersWithHttpInfo(String tenantId, String urlId, [GetOnlineUsersOptions? options]) → Future<Response>
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now. Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
getPagesPublic(String tenantId, [GetPagesPublicOptions? options]) → Future<GetPublicPagesResponse?>
List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires enableFChat to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
getPagesPublicWithHttpInfo(String tenantId, [GetPagesPublicOptions? options]) → Future<Response>
List pages for a tenant. Used by the FChat desktop client to populate its room list. Requires enableFChat to be true on the resolved custom config for each page. Pages that require SSO are filtered against the requesting user's group access.
getTranslations(String namespace, String component, [GetTranslationsOptions? options]) → Future<GetTranslationsResponse?>
Parameters:
getTranslationsWithHttpInfo(String namespace, String component, [GetTranslationsOptions? options]) → Future<Response>
Performs an HTTP 'GET /translations/{namespace}/{component}' operation and returns the Response. Parameters:
getUserNotificationCount(String tenantId, [String? sso]) → Future<GetUserNotificationCountResponse?>
Parameters:
getUserNotificationCountWithHttpInfo(String tenantId, [String? sso]) → Future<Response>
Performs an HTTP 'GET /user-notifications/get-count' operation and returns the Response. Parameters:
getUserNotifications(String tenantId, [GetUserNotificationsOptions? options]) → Future<GetMyNotificationsResponse?>
Parameters:
getUserNotificationsWithHttpInfo(String tenantId, [GetUserNotificationsOptions? options]) → Future<Response>
Performs an HTTP 'GET /user-notifications' operation and returns the Response. Parameters:
getUserPresenceStatuses(String tenantId, String urlIdWS, String userIds) → Future<GetUserPresenceStatusesResponse?>
Parameters:
getUserPresenceStatusesWithHttpInfo(String tenantId, String urlIdWS, String userIds) → Future<Response>
Performs an HTTP 'GET /user-presence-status' operation and returns the Response. Parameters:
getUserReactsPublic(String tenantId, [GetUserReactsPublicOptions? options]) → Future<UserReactsResponse?>
Parameters:
getUserReactsPublicWithHttpInfo(String tenantId, [GetUserReactsPublicOptions? options]) → Future<Response>
Performs an HTTP 'GET /feed-posts/{tenantId}/user-reacts' operation and returns the Response. Parameters:
getUsersInfo(String tenantId, String ids) → Future<PageUsersInfoResponse?>
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
getUsersInfoWithHttpInfo(String tenantId, String ids) → Future<Response>
Bulk user info for a tenant. Given userIds, return display info from User / SSOUser. Used by the comment widget to enrich users that just appeared via a presence event. No page context: privacy is enforced uniformly (private profiles are masked).
getV1PageLikes(String tenantId, String urlId) → Future<GetV1PageLikes?>
Parameters:
getV1PageLikesWithHttpInfo(String tenantId, String urlId) → Future<Response>
Performs an HTTP 'GET /page-reacts/v1/likes/{tenantId}' operation and returns the Response. Parameters:
getV2PageReacts(String tenantId, String urlId) → Future<GetV2PageReacts?>
Parameters:
getV2PageReactsWithHttpInfo(String tenantId, String urlId) → Future<Response>
Performs an HTTP 'GET /page-reacts/v2/{tenantId}' operation and returns the Response. Parameters:
getV2PageReactUsers(String tenantId, String urlId, String id) → Future<GetV2PageReactUsersResponse?>
Parameters:
getV2PageReactUsersWithHttpInfo(String tenantId, String urlId, String id) → Future<Response>
Performs an HTTP 'GET /page-reacts/v2/{tenantId}/list' operation and returns the Response. Parameters:
lockComment(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<APIEmptyResponse?>
Parameters:
lockCommentWithHttpInfo(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<Response>
Performs an HTTP 'POST /comments/{tenantId}/{commentId}/lock' operation and returns the Response. Parameters:
logoutPublic() → Future<APIEmptyResponse?>
logoutPublicWithHttpInfo() → Future<Response>
Performs an HTTP 'PUT /auth/logout' operation and returns the Response.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pinComment(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<ChangeCommentPinStatusResponse?>
Parameters:
pinCommentWithHttpInfo(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<Response>
Performs an HTTP 'POST /comments/{tenantId}/{commentId}/pin' operation and returns the Response. Parameters:
reactFeedPostPublic(String tenantId, String postId, ReactBodyParams reactBodyParams, [ReactFeedPostPublicOptions? options]) → Future<ReactFeedPostResponse?>
Parameters:
reactFeedPostPublicWithHttpInfo(String tenantId, String postId, ReactBodyParams reactBodyParams, [ReactFeedPostPublicOptions? options]) → Future<Response>
Performs an HTTP 'POST /feed-posts/{tenantId}/react/{postId}' operation and returns the Response. Parameters:
resetUserNotificationCount(String tenantId, [String? sso]) → Future<ResetUserNotificationsResponse?>
Parameters:
resetUserNotificationCountWithHttpInfo(String tenantId, [String? sso]) → Future<Response>
Performs an HTTP 'POST /user-notifications/reset-count' operation and returns the Response. Parameters:
resetUserNotifications(String tenantId, [ResetUserNotificationsOptions? options]) → Future<ResetUserNotificationsResponse?>
Parameters:
resetUserNotificationsWithHttpInfo(String tenantId, [ResetUserNotificationsOptions? options]) → Future<Response>
Performs an HTTP 'POST /user-notifications/reset' operation and returns the Response. Parameters:
searchUsers(String tenantId, String urlId, [SearchUsersOptions? options]) → Future<SearchUsersResult?>
Parameters:
searchUsersWithHttpInfo(String tenantId, String urlId, [SearchUsersOptions? options]) → Future<Response>
Performs an HTTP 'GET /user-search/{tenantId}' operation and returns the Response. Parameters:
setCommentText(String tenantId, String commentId, String broadcastId, CommentTextUpdateRequest commentTextUpdateRequest, [SetCommentTextOptions? options]) → Future<PublicAPISetCommentTextResponse?>
Parameters:
setCommentTextWithHttpInfo(String tenantId, String commentId, String broadcastId, CommentTextUpdateRequest commentTextUpdateRequest, [SetCommentTextOptions? options]) → Future<Response>
Performs an HTTP 'POST /comments/{tenantId}/{commentId}/update-text' operation and returns the Response. Parameters:
toString() → String
A string representation of this object.
inherited
unBlockCommentPublic(String tenantId, String commentId, PublicBlockFromCommentParams publicBlockFromCommentParams, [String? sso]) → Future<UnblockSuccess?>
Parameters:
unBlockCommentPublicWithHttpInfo(String tenantId, String commentId, PublicBlockFromCommentParams publicBlockFromCommentParams, [String? sso]) → Future<Response>
Performs an HTTP 'DELETE /block-from-comment/{commentId}' operation and returns the Response. Parameters:
unLockComment(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<APIEmptyResponse?>
Parameters:
unLockCommentWithHttpInfo(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<Response>
Performs an HTTP 'POST /comments/{tenantId}/{commentId}/unlock' operation and returns the Response. Parameters:
unPinComment(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<ChangeCommentPinStatusResponse?>
Parameters:
unPinCommentWithHttpInfo(String tenantId, String commentId, String broadcastId, [String? sso]) → Future<Response>
Performs an HTTP 'POST /comments/{tenantId}/{commentId}/unpin' operation and returns the Response. Parameters:
updateFeedPostPublic(String tenantId, String postId, UpdateFeedPostParams updateFeedPostParams, [UpdateFeedPostPublicOptions? options]) → Future<CreateFeedPostResponse?>
Parameters:
updateFeedPostPublicWithHttpInfo(String tenantId, String postId, UpdateFeedPostParams updateFeedPostParams, [UpdateFeedPostPublicOptions? options]) → Future<Response>
Performs an HTTP 'PUT /feed-posts/{tenantId}/{postId}' operation and returns the Response. Parameters:
updateUserNotificationCommentSubscriptionStatus(String tenantId, String notificationId, String optedInOrOut, String commentId, [String? sso]) → Future<UpdateUserNotificationCommentSubscriptionStatusResponse?>
Enable or disable notifications for a specific comment.
updateUserNotificationCommentSubscriptionStatusWithHttpInfo(String tenantId, String notificationId, String optedInOrOut, String commentId, [String? sso]) → Future<Response>
Enable or disable notifications for a specific comment.
updateUserNotificationPageSubscriptionStatus(String tenantId, String urlId, String url, String pageTitle, String subscribedOrUnsubscribed, [String? sso]) → Future<UpdateUserNotificationPageSubscriptionStatusResponse?>
Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
updateUserNotificationPageSubscriptionStatusWithHttpInfo(String tenantId, String urlId, String url, String pageTitle, String subscribedOrUnsubscribed, [String? sso]) → Future<Response>
Enable or disable notifications for a page. When users are subscribed to a page, notifications are created for new root comments, and also
updateUserNotificationStatus(String tenantId, String notificationId, String newStatus, [String? sso]) → Future<UpdateUserNotificationStatusResponse?>
Parameters:
updateUserNotificationStatusWithHttpInfo(String tenantId, String notificationId, String newStatus, [String? sso]) → Future<Response>
Performs an HTTP 'POST /user-notifications/{notificationId}/mark/{newStatus}' operation and returns the Response. Parameters:
uploadImage(String tenantId, MultipartFile file, [UploadImageOptions? options]) → Future<UploadImageResponse?>
Upload and resize an image
uploadImageWithHttpInfo(String tenantId, MultipartFile file, [UploadImageOptions? options]) → Future<Response>
Upload and resize an image
voteComment(String tenantId, String commentId, String urlId, String broadcastId, VoteBodyParams voteBodyParams, [VoteCommentOptions? options]) → Future<VoteResponse?>
Parameters:
voteCommentWithHttpInfo(String tenantId, String commentId, String urlId, String broadcastId, VoteBodyParams voteBodyParams, [VoteCommentOptions? options]) → Future<Response>
Performs an HTTP 'POST /comments/{tenantId}/{commentId}/vote' operation and returns the Response. Parameters:

Operators

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