Class default

Hierarchy

default

Index

Constructors

Properties

apiDomain apiEndPoint consumerKey consumerSecret hooks o oauthDomain oauthEndPoint 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 searchUserTimeline searchUsers updateNotifyNumber updateProfile updateProfileImage uploadPhoto verifyCredentials xauth

Constructors

constructor

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

Properties

apiDomain

apiDomain: string

`Private` `Readonly` apiEndPoint

apiEndPoint: string

consumerKey

consumerKey: string

consumerSecret

consumerSecret: string

hooks

hooks: FanfouHooks

`Private` `Readonly` o

o: OAuth

oauthDomain

oauthDomain: string

`Private` `Readonly` oauthEndPoint

oauthEndPoint: 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:221

checkBlockExists

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

checkFriendship

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

checkFriendshipDetail

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

checkFriendshipRequests

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

createBlockedUser

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

createDirectMessage

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

createFavorite

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

createFriendship

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

createSavedSearch

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

createStatus

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

denyFriendship

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

dismissRecommendedUser

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

dropBlockedUser

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

dropDirectMessage

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

dropFavorite

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

dropFriendship

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

dropSavedSearch

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

dropStatus

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

get

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

getAccessToken

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

getBlockedIds

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

getBlockedUsers

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

getContextTimeline

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

getConversation

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

getConversations

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

getFavorites

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

getFollowerIds

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

getFollowers

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

getFollowingIds

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

getFollowings

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

getHomeTimeline

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

getInbox

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

getMentions

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

getNotification

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

getPublicTimeline

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

getRateLimitStatus

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

getRecentFollowers

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

getRecentUsers

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

getRecommendedUsers

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

getReplies

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

getRequestToken

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

getSavedSearch

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

getSavedSearches

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

getSent

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

getStatus

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

getTaggedUsers

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

getTrends

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

getUser

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

getUserPhotos

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

getUserTags

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

getUserTimeline

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

post

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

searchPublicTimeline

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

searchUserTimeline

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

searchUsers

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

updateNotifyNumber

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

updateProfile

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

updateProfileImage

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

uploadPhoto

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

verifyCredentials

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

xauth

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

Generated using TypeDoc