Class default

Index

Constructors

Properties

apiDomain consumerKey consumerSecret hooks oauthDomain oauthToken oauthTokenSecret password protocol username

Methods

acceptFriendship checkBlockExists checkFriendship checkFriendshipDetail checkFriendshipRequests createBlockedUser createDirectMessage createFavorite createFriendship createSavedSearch createStatus denyFriendship dismissRecommendedUser dropBlockedUser dropDirectMessage dropFavorite dropFriendship dropSavedSearch dropStatus get getAccessToken getBlockedIds getBlockedUsers getContextTimeline getConversation getConversations getFavorites getFollowerIds getFollowers getFollowingIds getFollowings getHomeTimeline getInbox getMentions getNotification getPublicTimeline getRateLimitStatus getRecentFollowers getRecentUsers getRecommendedUsers getReplies getRequestToken getSavedSearch getSavedSearches getSent getStatus getTaggedUsers getTrends getUser getUserPhotos getUserTags getUserTimeline post searchPublicTimeline searchUsers searchUserTimeline updateNotifyNumber updateProfile updateProfileImage uploadPhoto verifyCredentials xauth

Constructors

constructor

new default(options?: FanfouOptions): default
Parameters
- options: FanfouOptions = {}
Returns default
- Defined in source/fanfou.ts:48

Properties

apiDomain

apiDomain: string

consumerKey

consumerKey: string

consumerSecret

consumerSecret: string

hooks

hooks: FanfouHooks

oauthDomain

oauthDomain: string

oauthToken

oauthToken: string

oauthTokenSecret

oauthTokenSecret: string

password

password: string

protocol

protocol: string

username

username: string

Methods

acceptFriendship

acceptFriendship(options: AcceptFriendshipOptions): Promise<User>
Parameters
- options: AcceptFriendshipOptions
Returns Promise<User>
- Defined in source/fanfou.ts:238

checkBlockExists

checkBlockExists(options: CheckBlockExistsOptions): Promise<User>
Parameters
- options: CheckBlockExistsOptions
Returns Promise<User>
- Defined in source/fanfou.ts:241

checkFriendship

checkFriendship(options: CheckFriendshipOptions): Promise<boolean>
Parameters
- options: CheckFriendshipOptions
Returns Promise<boolean>
- Defined in source/fanfou.ts:244

checkFriendshipDetail

checkFriendshipDetail(
options: CheckFriendshipDetailOptions,
): Promise<CheckFriendshipDetailResult>
Parameters
- options: CheckFriendshipDetailOptions
Returns Promise<CheckFriendshipDetailResult>
- Defined in source/fanfou.ts:247

checkFriendshipRequests

checkFriendshipRequests(
options: CheckFriendshipRequestsOptions,
): Promise<User[]>
Parameters
- options: CheckFriendshipRequestsOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:250

createBlockedUser

createBlockedUser(options: CreateBlockedUserOptions): Promise<User>
Parameters
- options: CreateBlockedUserOptions
Returns Promise<User>
- Defined in source/fanfou.ts:254

createDirectMessage

createDirectMessage(options: CreateDirectMessageOptions): Promise<DirectMessage>
Parameters
- options: CreateDirectMessageOptions
Returns Promise<DirectMessage>
- Defined in source/fanfou.ts:257

createFavorite

createFavorite(options: CreateFavoriteOptions): Promise<Status>
Parameters
- options: CreateFavoriteOptions
Returns Promise<Status>
- Defined in source/fanfou.ts:260

createFriendship

createFriendship(options: CreateFriendshipOptions): Promise<User>
Parameters
- options: CreateFriendshipOptions
Returns Promise<User>
- Defined in source/fanfou.ts:263

createSavedSearch

createSavedSearch(options: CreateSavedSearchOptions): Promise<Trend>
Parameters
- options: CreateSavedSearchOptions
Returns Promise<Trend>
- Defined in source/fanfou.ts:266

createStatus

createStatus(options: CreateStatusOptions): Promise<Status>
Parameters
- options: CreateStatusOptions
Returns Promise<Status>
- Defined in source/fanfou.ts:269

denyFriendship

denyFriendship(options: DenyFriendshipOptions): Promise<User>
Parameters
- options: DenyFriendshipOptions
Returns Promise<User>
- Defined in source/fanfou.ts:272

dismissRecommendedUser

dismissRecommendedUser(options: DismissRecommendedUserOptions): Promise<User>
Parameters
- options: DismissRecommendedUserOptions
Returns Promise<User>
- Defined in source/fanfou.ts:275

dropBlockedUser

dropBlockedUser(options: DropBlockedUserOptions): Promise<User>
Parameters
- options: DropBlockedUserOptions
Returns Promise<User>
- Defined in source/fanfou.ts:278

dropDirectMessage

dropDirectMessage(options: DropDirectMessageOptions): Promise<DirectMessage>
Parameters
- options: DropDirectMessageOptions
Returns Promise<DirectMessage>
- Defined in source/fanfou.ts:281

dropFavorite

dropFavorite(options: DropFavoriteOptions): Promise<Status>
Parameters
- options: DropFavoriteOptions
Returns Promise<Status>
- Defined in source/fanfou.ts:284

dropFriendship

dropFriendship(options: DropFriendshipOptions): Promise<User>
Parameters
- options: DropFriendshipOptions
Returns Promise<User>
- Defined in source/fanfou.ts:287

dropSavedSearch

dropSavedSearch(options: DropSavedSearchOptions): Promise<Trend>
Parameters
- options: DropSavedSearchOptions
Returns Promise<Trend>
- Defined in source/fanfou.ts:290

dropStatus

dropStatus(options: DropStatusOptions): Promise<User>
Parameters
- options: DropStatusOptions
Returns Promise<User>
- Defined in source/fanfou.ts:293

get

get<T>(uri: string, parameters?: Record<string, any>): Promise<T>
Type Parameters
- T
Parameters
- uri: string
- parameters: Record<string, any> = {}
Returns Promise<T>
- Defined in source/fanfou.ts:165

getAccessToken

getAccessToken(token: FanfouToken): Promise<default>
Parameters
- token: FanfouToken
Returns Promise<default>
- Defined in source/fanfou.ts:104

getBlockedIds

getBlockedIds(): Promise<string[]>
Returns Promise<string[]>
- Defined in source/fanfou.ts:296

getBlockedUsers

getBlockedUsers(options?: GetBlockedUsersOptions): Promise<User[]>
Parameters
- Optionaloptions: GetBlockedUsersOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:298

getContextTimeline

getContextTimeline(options: GetContextTimelineOptions): Promise<Status[]>
Parameters
- options: GetContextTimelineOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:301

getConversation

getConversation(options: GetConversationOptions): Promise<DirectMessage[]>
Parameters
- options: GetConversationOptions
Returns Promise<DirectMessage[]>
- Defined in source/fanfou.ts:304

getConversations

getConversations(
options?: GetConversationsOptions,
): Promise<GetConversationsOptions>
Parameters
- Optionaloptions: GetConversationsOptions
Returns Promise<GetConversationsOptions>
- Defined in source/fanfou.ts:307

getFavorites

getFavorites(options?: GetFavoritesOptions): Promise<Status[]>
Parameters
- Optionaloptions: GetFavoritesOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:310

getFollowerIds

getFollowerIds(options?: GetFollowerIdsOptions): Promise<string[]>
Parameters
- Optionaloptions: GetFollowerIdsOptions
Returns Promise<string[]>
- Defined in source/fanfou.ts:313

getFollowers

getFollowers(options?: GetFollowersOptions): Promise<User[]>
Parameters
- Optionaloptions: GetFollowersOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:316

getFollowingIds

getFollowingIds(options?: GetFollowingIdsOptions): Promise<string[]>
Parameters
- Optionaloptions: GetFollowingIdsOptions
Returns Promise<string[]>
- Defined in source/fanfou.ts:319

getFollowings

getFollowings(options?: GetFollowingsOptions): Promise<User[]>
Parameters
- Optionaloptions: GetFollowingsOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:322

getHomeTimeline

getHomeTimeline(options?: GetHomeTimelineOptions): Promise<Status[]>
Parameters
- Optionaloptions: GetHomeTimelineOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:325

getInbox

getInbox(options?: GetInboxOptions): Promise<DirectMessage[]>
Parameters
- Optionaloptions: GetInboxOptions
Returns Promise<DirectMessage[]>
- Defined in source/fanfou.ts:328

getMentions

getMentions(options: GetMentionsOptions): Promise<Status[]>
Parameters
- options: GetMentionsOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:331

getNotification

getNotification(): Promise<GetNotificationResult>
Returns Promise<GetNotificationResult>
- Defined in source/fanfou.ts:334

getPublicTimeline

getPublicTimeline(options: GetPublicTimelineOptions): Promise<Status[]>
Parameters
- options: GetPublicTimelineOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:336

getRateLimitStatus

getRateLimitStatus(
options: GetRateLimitStatusOptions,
): Promise<GetRateLimitStatusResult>
Parameters
- options: GetRateLimitStatusOptions
Returns Promise<GetRateLimitStatusResult>
- Defined in source/fanfou.ts:339

getRecentFollowers

getRecentFollowers(options: GetRecentFollowersOptions): Promise<User[]>
Parameters
- options: GetRecentFollowersOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:342

getRecentUsers

getRecentUsers(options: GetRecentUsersOptions): Promise<User[]>
Parameters
- options: GetRecentUsersOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:345

getRecommendedUsers

getRecommendedUsers(options: GetRecommendedUsersOptions): Promise<User[]>
Parameters
- options: GetRecommendedUsersOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:348

getReplies

getReplies(options: GetRepliesOptions): Promise<Status[]>
Parameters
- options: GetRepliesOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:351

getRequestToken

getRequestToken(): Promise<default>
Returns Promise<default>
- Defined in source/fanfou.ts:81

getSavedSearch

getSavedSearch(options: GetSavedSearchOptions): Promise<Trend>
Parameters
- options: GetSavedSearchOptions
Returns Promise<Trend>
- Defined in source/fanfou.ts:354

getSavedSearches

getSavedSearches(options: GetSavedSearchesOptions): Promise<Trend[]>
Parameters
- options: GetSavedSearchesOptions
Returns Promise<Trend[]>
- Defined in source/fanfou.ts:357

getSent

getSent(options: GetSentOptions): Promise<DirectMessage[]>
Parameters
- options: GetSentOptions
Returns Promise<DirectMessage[]>
- Defined in source/fanfou.ts:360

getStatus

getStatus(options: GetStatusOptions): Promise<Status>
Parameters
- options: GetStatusOptions
Returns Promise<Status>
- Defined in source/fanfou.ts:362

getTaggedUsers

getTaggedUsers(options: GetTaggedUsersOptions): Promise<User[]>
Parameters
- options: GetTaggedUsersOptions
Returns Promise<User[]>
- Defined in source/fanfou.ts:365

getTrends

getTrends(options: GetTrendsOptions): Promise<GetTrendsResult>
Parameters
- options: GetTrendsOptions
Returns Promise<GetTrendsResult>
- Defined in source/fanfou.ts:368

getUser

getUser(options: GetUserOptions): Promise<User>
Parameters
- options: GetUserOptions
Returns Promise<User>
- Defined in source/fanfou.ts:371

getUserPhotos

getUserPhotos(options: GetUserPhotosOptions): Promise<Status>
Parameters
- options: GetUserPhotosOptions
Returns Promise<Status>
- Defined in source/fanfou.ts:373

getUserTags

getUserTags(options: GetUserTagsOptions): Promise<string[]>
Parameters
- options: GetUserTagsOptions
Returns Promise<string[]>
- Defined in source/fanfou.ts:376

getUserTimeline

getUserTimeline(options: GetUserTimelineOptions): Promise<Status[]>
Parameters
- options: GetUserTimelineOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:379

post

post<T>(uri: string, parameters?: Record<string, any>): Promise<T>
Type Parameters
- T
Parameters
- uri: string
- parameters: Record<string, any> = {}
Returns Promise<T>
- Defined in source/fanfou.ts:191

searchPublicTimeline

searchPublicTimeline(options: SearchPublicTimelineOptions): Promise<Status[]>
Parameters
- options: SearchPublicTimelineOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:382

searchUsers

searchUsers(options: SearchUsersOptions): Promise<SearchUsersResult>
Parameters
- options: SearchUsersOptions
Returns Promise<SearchUsersResult>
- Defined in source/fanfou.ts:388

searchUserTimeline

searchUserTimeline(options: SearchUserTimelineOptions): Promise<Status[]>
Parameters
- options: SearchUserTimelineOptions
Returns Promise<Status[]>
- Defined in source/fanfou.ts:385

updateNotifyNumber

updateNotifyNumber(
options: UpdateNotifyNumberOptions,
): Promise<UpdateNotifyNumberResult>
Parameters
- options: UpdateNotifyNumberOptions
Returns Promise<UpdateNotifyNumberResult>
- Defined in source/fanfou.ts:391

updateProfile

updateProfile(options: UpdateProfileOptions): Promise<User>
Parameters
- options: UpdateProfileOptions
Returns Promise<User>
- Defined in source/fanfou.ts:394

updateProfileImage

updateProfileImage(options: UpdateProfileImageOptions): Promise<User>
Parameters
- options: UpdateProfileImageOptions
Returns Promise<User>
- Defined in source/fanfou.ts:397

uploadPhoto

uploadPhoto(options: UploadPhotoOptions): Promise<Status>
Parameters
- options: UploadPhotoOptions
Returns Promise<Status>
- Defined in source/fanfou.ts:400

verifyCredentials

verifyCredentials(options: VerifyCredentialsOptions): Promise<User>
Parameters
- options: VerifyCredentialsOptions
Returns Promise<User>
- Defined in source/fanfou.ts:403

xauth

xauth(): Promise<default>
Returns Promise<default>
- Defined in source/fanfou.ts:130