new Stories(opts)
Snapchat wrapper for story-related API calls.
Parameters:
Name | Type | Description |
---|---|---|
opts |
Object |
- Source:
Methods
-
deleteStory(story, cb)
-
Deletes a story of yours.
Parameters:
Name Type Description story
UserStory cb
function - Source:
-
getSharedDescriptionForStory(sharedStory, cb)
-
Retrieves the description for a shared story.
Parameters:
Name Type Description sharedStory
A shared story.
cb
function - Source:
-
hideSharedStory(cb)
-
Hides a shared story from the story feed.
Parameters:
Name Type Description cb
function - Source:
-
loadStories(stories, cb)
-
Batch loads media for a set of stories.
Parameters:
Name Type Description stories
Array.<Story> An array of Story objects whose media you wish to download.
cb
function - Source:
-
loadStoryBlob(story, cb)
-
Downloads media for a story.
Parameters:
Name Type Description story
Story The story to download.
cb
function SKBlob
- Source:
-
loadStoryThumbnailBlob(story, cb)
-
Downloads the thumbnail for a story.
Parameters:
Name Type Description story
The story whose thumbnail you wish to download.
cb
function SKBlob
- Source:
-
markStoriesViewed(stories, cb)
-
Marks a set of stories as opened.
Parameters:
Name Type Description stories
Array.<StoryUpdater> An array of StoryUpdater objects.
cb
function - Source:
-
markStoryViewed(story, sscount, cb)
-
Marks a single story opened. To batch mark stories viewed, use markStoriesViewed
Parameters:
Name Type Description story
Story The story to mark as opened.
sscount
number The number of times the story was screenshotted.
cb
function - Source:
-
postStory(blob, opts, cb)
-
Posts a story with the given options.
Parameters:
Name Type Description blob
Blob The Blob object containing the image or video data to send.
opts
StoryOptions The options for the story to post.
cb
function - Source:
-
provideSharedDescription(sharedStory, cb)
-
Does nothing if the story is not a shared story.
Parameters:
Name Type Description sharedStory
Story A shared story.
cb
function - Source: