Skip to content

post.md

Latest commit

 

History

History
98 lines (62 loc) · 2.42 KB

post.md

File metadata and controls

98 lines (62 loc) · 2.42 KB

Class: SocialMediaPost

Represents a post on a social media platform.

SocialMediaPost(options)

const socialMediaPost = new SocialMediaPost({
  ... // see fields below
})

socialMediaPost.authoredAt

When the post was authored.

socialMediaPost.fetchedAt

When the post was fetched by a Channel.

socialMediaPost.author

  • Type: string

The author of the post, typically a username.

socialMediaPost.url

  • Type: string

The URL of the post.

socialMediaPost.platform

The social media platform that the post was authored on.

socialMediaPost.platformID

  • Type: string

The ID of the post on the platform it was authored on.

socialMediaPost.content?

  • Type: string

The textual content of the post.

socialMediaPost.raw

  • Type: Object.<string, any>

Additional raw data about the post returned by an external data source like a web API.

socialMediaPost.getTimestamp()

Returns the value of the socialMediaPost.authoredAt field.

Interface: SocialMediaOptions

socialMediaOptions.authoredAt

See socialMediaPost.authoredAt.

socialMediaOptions.fetchedAt

See socialMediaPost.fetchedAt.

socialMediaOptions.author

See socialMediaPost.author.

socialMediaOptions.url

See socialMediaPost.url.

socialMediaOptions.platform

See socialMediaPost.platform.

socialMediaOptions.platformID

See socialMediaPost.platformID.

socialMediaOptions.content?

See socialMediaPost.content?.

socialMediaOptions.raw

See socialMediaPost.raw.

Enum: Platform

A social media platform.

Facebook

  • Value: 'facebook'

Instagram

  • Value: 'instagram'

Twitter

  • Value: 'twitter'