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 storyUserStory cbfunction - Source:
-
getSharedDescriptionForStory(sharedStory, cb)
-
Retrieves the description for a shared story.
Parameters:
Name Type Description sharedStoryA shared story.
cbfunction - Source:
-
hideSharedStory(cb)
-
Hides a shared story from the story feed.
Parameters:
Name Type Description cbfunction - Source:
-
loadStories(stories, cb)
-
Batch loads media for a set of stories.
Parameters:
Name Type Description storiesArray.<Story> An array of Story objects whose media you wish to download.
cbfunction - Source:
-
loadStoryBlob(story, cb)
-
Downloads media for a story.
Parameters:
Name Type Description storyStory The story to download.
cbfunction SKBlob
- Source:
-
loadStoryThumbnailBlob(story, cb)
-
Downloads the thumbnail for a story.
Parameters:
Name Type Description storyThe story whose thumbnail you wish to download.
cbfunction SKBlob
- Source:
-
markStoriesViewed(stories, cb)
-
Marks a set of stories as opened.
Parameters:
Name Type Description storiesArray.<StoryUpdater> An array of StoryUpdater objects.
cbfunction - Source:
-
markStoryViewed(story, sscount, cb)
-
Marks a single story opened. To batch mark stories viewed, use markStoriesViewed
Parameters:
Name Type Description storyStory The story to mark as opened.
sscountnumber The number of times the story was screenshotted.
cbfunction - Source:
-
postStory(blob, opts, cb)
-
Posts a story with the given options.
Parameters:
Name Type Description blobBlob The Blob object containing the image or video data to send.
optsStoryOptions The options for the story to post.
cbfunction - Source:
-
provideSharedDescription(sharedStory, cb)
-
Does nothing if the story is not a shared story.
Parameters:
Name Type Description sharedStoryStory A shared story.
cbfunction - Source: