Skip to content

Latest commit

 

History

History
131 lines (98 loc) · 3.25 KB

Filter.md

File metadata and controls

131 lines (98 loc) · 3.25 KB
Raw

Filter

Filters are used to hide content in columns. TD.vo.Filter is the base class for many other filter types.

Table of Contents

Constants

Enumerators

Name Description
PHRASE "Words and phrases" filter type
SENDER "Sender" (User) filter type
SOURCE "Source" filter type
FOLLOWERS "Followers" filter type (unused)
IS_RETWEET "is Retweet" filter type
IS_MENTION "is Mention" filter type
IS_FAVORITE "is Favorite" (Like) filter type
IS_FOLLOW "is Follow" filter type
IS_ACTION_ON_RETWEET "is action on Retweet" (Liked/Retweeted your RT) filter type
IS_QUOTED "is Quoted" filter type
HAS_IMAGE "has image" filter type
HAS_VIDEO "has video" filter type
HAS_GIF "has GIF" filter type
HAS_VINE "has Vine" filter type
HAS_MEDIA "has media" filter type
HAS_LINK "has link" filter type
IS_FROM_VERIFIED "is from verified" filter type
CHIRP_TYPE "chirp_type" filter
LOCATION "Location" filter type
SINCE_TIME "since time" filter type
UNTIL_TIME "until time" filter type

Properties

Name Description
id Local ID of the filter
value Value of the filter (what will be checked against in type)
type Type of the filter, one of Enumerators
positive Negate checks of filters (???) (unused)
exact If the target needs to match the filter exactly
fuzzy Fuzzy matching (?), actually only prepends @ before checks
range Used in Number checks
filter_target Returns the target tweet or actual tweet

Methods

pass

Parameters:

  • tweet TwitterStatus

Description:
Passes specific parts of tweet to tester functions, depending on type

getDisplayType

Parameters:
None

Description:
Get a display type description for the type of the current filter

_getFilterTarget

Parameters:

  • tweet TwitterStatus

Description:
Returns tweet or the tweets target status, depending on filter_target

_testString

Parameters:

  • text String

Description:
Matches text against value of the filter

_testNumber

Parameters:

  • num Number

Description:
Matches num against value of the filter, or if num is in range (if specified)

_testBoolean

Parameters:

  • bool Boolean

Description:
Matches bool against value

toBackendState

Returns:

  • object Object
    • type
    • value
    • positive
    • exact
    • fuzzy
    • range

Description:
Returns a object which is ready to be pushed into the TweetDeck backend

fromBackendState

Parameters:

  • data Object

Description:
Gets passed data from backend and fills in corresponding properties