- StarApiFactory(configuration?, basePath?, axios?): {
getCommentStargazers(teamName, commentId, page?, perPage?, options?) => AxiosPromise<PaginatedStargazers>;
getPostStargazers(teamName, postNumber, page?, perPage?, options?) => AxiosPromise<PaginatedStargazers>;
starComment(teamName, commentId, newStar, options?) => AxiosPromise<void>;
starPost(teamName, postNumber, newStar, options?) => AxiosPromise<void>;
unstarComment(teamName, commentId, options?) => AxiosPromise<void>;
unstarPost(teamName, postNumber, options?) => AxiosPromise<void>;
}
-
Parameters
-
-
Optional
basePath: string
-
Optional
axios: AxiosInstance
Returns {
getCommentStargazers(teamName, commentId, page?, perPage?, options?) => AxiosPromise<PaginatedStargazers>;
getPostStargazers(teamName, postNumber, page?, perPage?, options?) => AxiosPromise<PaginatedStargazers>;
starComment(teamName, commentId, newStar, options?) => AxiosPromise<void>;
starPost(teamName, postNumber, newStar, options?) => AxiosPromise<void>;
unstarComment(teamName, commentId, options?) => AxiosPromise<void>;
unstarPost(teamName, postNumber, options?) => AxiosPromise<void>;
}
-
getCommentStargazers:function
-
Parameters
-
teamName: string
-
commentId: number
-
Optional
page: number
-
Optional
perPage: number
-
Optional
options: any
-
getPostStargazers:function
- getPostStargazers(teamName, postNumber, page?, perPage?, options?): AxiosPromise<PaginatedStargazers>
-
Parameters
-
teamName: string
-
postNumber: number
-
Optional
page: number
-
Optional
perPage: number
-
Optional
options: any
-
starComment:function
-
Parameters
-
teamName: string
-
commentId: number
-
-
Optional
options: any
Returns AxiosPromise<void>
-
starPost:function
- starPost(teamName, postNumber, newStar, options?): AxiosPromise<void>
-
Parameters
-
teamName: string
-
postNumber: number
-
-
Optional
options: any
Returns AxiosPromise<void>
-
unstarComment:function
-
Parameters
-
teamName: string
-
commentId: number
-
Optional
options: any
Returns AxiosPromise<void>
-
unstarPost:function
- unstarPost(teamName, postNumber, options?): AxiosPromise<void>
-
Parameters
-
teamName: string
-
postNumber: number
-
Optional
options: any
Returns AxiosPromise<void>
StarApi - factory interface