Scope enum

Scopes allow you to set granular access for your App so that your App only has the permissions that it needs. To learn more about what scopes map to what endpoints, see authentication mapping guide.

Inheritance

Constructors

Scope(String value)
const

Values

tweetRead → const Scope

All the Tweets you can view, including Tweets from protected accounts.

const Scope('tweet.read')
tweetWrite → const Scope

Tweet and Retweet for you.

const Scope('tweet.write')
tweetModerateWrite → const Scope

Hide and unhide replies to your Tweets.

const Scope('tweet.moderate.write')
usersRead → const Scope

Any account you can view, including protected accounts.

const Scope('users.read')
followsRead → const Scope

People who follow you and people who you follow.

const Scope('follows.read')
followsWrite → const Scope

Follow and unfollow people for you.

const Scope('follows.write')
offlineAccess → const Scope

Stay connected to your account until you revoke access.

const Scope('offline.access')
spaceRead → const Scope

All the Spaces you can view.

const Scope('space.read')
muteRead → const Scope

Accounts you’ve muted.

const Scope('mute.read')
muteWrite → const Scope

Mute and unmute accounts for you.

const Scope('mute.write')
likeRead → const Scope

Tweets you’ve liked and likes you can view.

const Scope('like.read')
likeWrite → const Scope

Like and un-like Tweets for you.

const Scope('like.write')
listRead → const Scope

Lists, list members, and list followers of lists you’ve created or are a member of, including private lists.

const Scope('list.read')
listWrite → const Scope

Create and manage Lists for you.

const Scope('list.write')
blockRead → const Scope

Accounts you’ve blocked.

const Scope('block.read')
blockWrite → const Scope

Block and unblock accounts for you.

const Scope('block.write')
bookmarkRead → const Scope

Get Bookmarked Tweets from an authenticated user.

const Scope('bookmark.read')
bookmarkWrite → const Scope

Bookmark and remove Bookmarks from Tweets.

const Scope('bookmark.write')
directMessageRead → const Scope

Get direct messages from an authenticated user.

const Scope('dm.read')
directMessageWrite → const Scope

Write and remove direct messages.

const Scope('dm.write')

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
value String
The scope value
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

valueOf(String value) Scope
Returns the scope associated with the given value.

Constants

values → const List<Scope>
A constant List of the values in this enum, in order of their declaration.