Single Story Retrieval
Get individual stories by ID with live object updates
Active Story Collections
Retrieve non-expired stories with optimistic creation support
Multi-Target Queries
Fetch stories from multiple communities simultaneously
Real-time Updates
Live synchronization of story states, reactions, and view counts
All story retrieval functions return Live Objects or Live Collections that automatically update when subscribed to Real-time Events, ensuring your app stays current with the latest story interactions.
Get Single Story
ThegetStory()
function retrieves individual stories by ID, returning a Live Object that observes real-time updates including reactions, view states, and other dynamic properties.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
storyId | String | Yes | Unique identifier of the story to retrieve |
Get Active Stories
ThegetActiveStories()
function retrieves non-expired stories for a specific target, providing a Live Collection optimized for story feed implementation with optimistic creation support.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
targetType | Enum | Yes | Type of target (currently supports .community ) |
targetId | String | Yes | ID of the target community |
sortOption | Enum | No | Sorting order: .firstCreated or .lastCreated (default: .firstCreated ) |
Real-time exclusion of expired stories from Live Collections is not supported. Stories will remain in the collection until the next refresh or manual query.
Get Stories by Targets
ThegetStoriesByTargets()
function enables retrieval of stories from multiple communities simultaneously, perfect for pre-downloading content and building comprehensive story feeds.
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
targets | Array | Yes | Array of target pairs (max 10 targets) |
sortOption | Enum | No | Sorting order across all targets |
Target Configuration
- Maximum Targets: Up to 10 target pairs per request
- Target Format: Pairs of
targetType
andtargetId
- Story Filter: Returns only
SYNCED
stories (excludes optimistic stories) - Cross-Target Sorting: Stories sorted across all targets by specified option