ChirpBase.md

ChirpBase

Base model for chirps (objects displayed in columns)

Table of Contents

• Properties
• Methods
  • belongsAbove
  • belongsBelow
  • createdPretty
  • createdPrettyFull
  • createdPrettyTimeOrDate
  • destroy
  • email
  • fromJSONObject
  • fudgeCreatedTime
  • getApiBounds
  • getCardUrl
  • getCardsForGallery
  • getChirpType
  • getChirpURL
  • getDOMChirps
  • getFilterableText
  • getMedia
  • getNotificationData
  • getRelatedTweet
  • getScribeItemData
  • getSenders
  • getSinceId
  • getSortIndex
  • getUnreadChirps
  • hasAnimatedGif
  • hasCard
  • hasImage
  • hasLink
  • hasMedia
  • hasVideo
  • hasVine
  • isFromVerifiedUser
  • isMediaGridContent
  • isOwnChirp
  • isRetweetedStatus
  • isStreamed
  • isTranslatable
  • mediaLength
  • passFilters
  • postComment
  • render
  • scribeMediaImpression
  • setApiBounds
  • translate
  • _generateHTMLText

Properties

Name	Description
apiBounds	API bounds of this chirp
apiSource	API source of this chirp
chirpType	Type of this chirp, usually defined by child classes
created	Creation date of this chirp
creatorAccount	???
cursor	???
embeds	???
htmlText	HTML formatted text of this chirp
id	ID of this chirp
isListAction	Boolean flag if this chirp is a list action
isQuoteStatus	Boolean flag if this chirp contains a quote
sortIndex	Object containing information on column sorting
text	Text of this chirp
_hasAnimatedGif	Boolean flag if this chirp has a animated GIF
_hasImage	Boolean flag if this chirp has an image
_hasLink	Boolean flag if this chirp has a link
_hasVideo	Boolean flag if this chirp has a video
_hasVine	Boolean flag if this chirp contains a Vine

Methods

belongsAbove

Parameters:

• e ChirpBase

Description:
Returns if this chirp belongs above another chirp

belongsBelow

Parameters:

• e ChirpBase

Description:
Returns if this chirp belongs below another chirp

createdPretty

Parameters:
None

Description:
Returns prettified creation date of this chirp

createdPrettyFull

Parameters:
None

Description:
Returns prettified full creation date of this chirp

createdPrettyTimeOrDate

Parameters:
None

Description:
Returns prettified creation time or date of this chirp

destroy

Parameters:
None

Description: Destroys this chirp

email

fromJSONObject

fudgeCreatedTime

Parameters:

• e ???

Description:
Fudges the creation date of the current chirp

getApiBounds

Parameters:

• e API boundary (optional)

Description:
Returns API bounds

getCardUrl

Parameters:
None

Description:
Returns the card URL of the current tweet

getCardsForGallery

getChirpType

Parameters:
None

Description:
Returns the chirp type

getChirpURL

getDOMChirps

Parameters:
None

Description:
Returns DOM object of this chirp

getFilterableText

Parameters:
None

Description:
Returns plain text of this chirp

getMedia

Parameters:
None

Description:
Returns media of this chirp

getNotificationData

getRelatedTweet

getScribeItemData

getSenders

getSinceId

Parameters:
None

Description:
Returns ID of this chirp

getSortIndex

Parameters:
None

Description:
Returns sort index of this chirp

getUnreadChirps

Parameters:

• e ChirpBase

Description:
Returns read status of chirp

hasAnimatedGif

Parameters:
None

Description:
Returns if this chirp has a animated GIF

hasCard

Parameters:
None

Description:
Returns if this chirp has a card

hasImage

Parameters:
None

Description:
Returns if this chirp has a image

hasLink

Parameters:
None

Description:
Returns if this chirp has a link

hasMedia

Parameters:
None

Description:
Returns if this chirp has media attached

hasVideo

Parameters:
None

Description:
Returns if this chirp has a video

hasVine

Parameters:
None

Description:
Returns if this chirp has a Vine attached

isFromVerifiedUser

isMediaGridContent

Parameters:
None

Description:
Returns if this chirp has more than one piece of media

isOwnChirp

isRetweetedStatus

isStreamed

Parameters:
None

Description:
Returns if this chirp was streamed in realtime

isTranslatable

mediaLength

Parameters:
None

Description:
Returns count of attached media

passFilters

Parameters:

• ??? (optional)

Description:
Checks if this chirp passes all filters

postComment

render

scribeMediaImpression

setApiBounds

Parameters:

• e API boundary
• t Boundary data

Description:
Sets API bounds

translate

_generateHTMLText

Parameters:
None

Description:
Generates HTML text for this chirp