Module net.bis5.mattermost4j.core

Package net.bis5.mattermost.client4.api

Interface PostApi

All Known Implementing Classes:

MattermostClient

public interface PostApi

Post API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method	Description
ApiResponse<Post>	createEphemeralPost(String targetUserId, Post post)	creates an ephemeral post send to targetUserId.
ApiResponse<Post>	createPost(Post post)	creates a post based on the provided post object.
ApiResponse<Boolean>	deletePost(String postId)	deletes a post from the provided post id string.
ApiResponse<FileInfo[]>	getFileInfoForPost(String postId)	get a list of file info attached the post.
default ApiResponse<PostList>	getFlaggedPostsForUser(String userId)	returns flagges posts of a user based on user id string.
ApiResponse<PostList>	getFlaggedPostsForUser(String userId, Pager pager)	returns flagges posts of a user based on user id string.
default ApiResponse<PostList>	getFlaggedPostsForUserInChannel(String userId, String channelId)	returns flagged posts in channel of a user based on user id string.
ApiResponse<PostList>	getFlaggedPostsForUserInChannel(String userId, String channelId, Pager pager)	returns flagged posts in channel of a user based on user id string.
default ApiResponse<PostList>	getFlaggedPostsForUserInTeam(String userId, String teamId)	returns flagged posts in team of a user based on user id string.
ApiResponse<PostList>	getFlaggedPostsForUserInTeam(String userId, String teamId, Pager pager)	returns flagged posts in team of a user based on user id string.
default ApiResponse<Post>	getPost(String postId)	gets a single post.
ApiResponse<Post>	getPost(String postId, String etag)	gets a single post.
default ApiResponse<PostList>	getPostsAfter(String channelId, String postId)	gets a page of posts that were posted after the post provided.
default ApiResponse<PostList>	getPostsAfter(String channelId, String postId, Pager pager)	gets a page of posts that were posted after the post provided.
ApiResponse<PostList>	getPostsAfter(String channelId, String postId, Pager pager, String etag)	gets a page of posts that were posted after the post provided.
default ApiResponse<PostList>	getPostsBefore(String channelId, String postId)	gets a page of posts that were posted before the post provided.
default ApiResponse<PostList>	getPostsBefore(String channelId, String postId, Pager pager)	gets a page of posts that were posted before the post provided.
ApiResponse<PostList>	getPostsBefore(String channelId, String postId, Pager pager, String etag)	gets a page of posts that were posted before the post provided.
default ApiResponse<PostList>	getPostsForChannel(String channelId)	gets a page of posts with an array for ordering for a channel.
default ApiResponse<PostList>	getPostsForChannel(String channelId, Pager pager)	gets a page of posts with an array for ordering for a channel.
ApiResponse<PostList>	getPostsForChannel(String channelId, Pager pager, String etag)	gets a page of posts with an array for ordering for a channel.
ApiResponse<PostList>	getPostsSince(String channelId, long since)	gets posts created after a specified time as Unix time in milliseconds.
default ApiResponse<PostList>	getPostsSince(String channelId, Date since)	gets posts created after a specified time as Unix time in milliseconds.
default ApiResponse<PostList>	getPostsSince(String channelId, ZonedDateTime since)	gets posts created after a specified time as Unix time in milliseconds.
default ApiResponse<PostList>	getPostThread(String postId)	gets a post with all the other posts in the same thread.
ApiResponse<PostList>	getPostThread(String postId, String etag)	gets a post with all the other posts in the same thread.
ApiResponse<Post>	patchPost(String postId, PostPatch patch)	partially updates a post.
ApiResponse<Boolean>	pinPost(String postId)	pin a post based on proviced post id string.
default ApiResponse<PostSearchResults>	searchPosts(String teamId, String terms)	returns any posts with matching term string.
ApiResponse<PostSearchResults>	searchPosts(String teamId, String terms, boolean isOrSearch)	returns any posts with matching term string.
ApiResponse<Boolean>	unpinPost(String postId)	unpin a post based on provided post id string.
default ApiResponse<Post>	updatePost(String postId, Post post)	Deprecated. use updatePost(Post) instead.
ApiResponse<Post>	updatePost(Post post)	updates a post based on the provided post object.

Method Detail

createPost

ApiResponse<Post> createPost(Post post)

creates a post based on the provided post object.

createEphemeralPost

ApiResponse<Post> createEphemeralPost(String targetUserId,
                                      Post post)

creates an ephemeral post send to targetUserId.

updatePost

ApiResponse<Post> updatePost(Post post)

updates a post based on the provided post object.

updatePost

@Deprecated
default ApiResponse<Post> updatePost(String postId,
                                     Post post)

Deprecated.

use updatePost(Post) instead.

updates a post based on the provided post object.

patchPost

ApiResponse<Post> patchPost(String postId,
                            PostPatch patch)

partially updates a post. Any missing fields are not updated.

pinPost

ApiResponse<Boolean> pinPost(String postId)

pin a post based on proviced post id string.

unpinPost

ApiResponse<Boolean> unpinPost(String postId)

unpin a post based on provided post id string.

getPost

default ApiResponse<Post> getPost(String postId)

gets a single post.

getPost

ApiResponse<Post> getPost(String postId,
                          String etag)

gets a single post.

deletePost

ApiResponse<Boolean> deletePost(String postId)

deletes a post from the provided post id string.

getPostThread

default ApiResponse<PostList> getPostThread(String postId)

gets a post with all the other posts in the same thread.

getPostThread

ApiResponse<PostList> getPostThread(String postId,
                                    String etag)

gets a post with all the other posts in the same thread.

getPostsForChannel

default ApiResponse<PostList> getPostsForChannel(String channelId)

gets a page of posts with an array for ordering for a channel.

getPostsForChannel

default ApiResponse<PostList> getPostsForChannel(String channelId,
                                                 Pager pager)

gets a page of posts with an array for ordering for a channel.

getPostsForChannel

ApiResponse<PostList> getPostsForChannel(String channelId,
                                         Pager pager,
                                         String etag)

gets a page of posts with an array for ordering for a channel.

getFlaggedPostsForUser

default ApiResponse<PostList> getFlaggedPostsForUser(String userId)

returns flagges posts of a user based on user id string.

getFlaggedPostsForUser

ApiResponse<PostList> getFlaggedPostsForUser(String userId,
                                             Pager pager)

returns flagges posts of a user based on user id string.

getFlaggedPostsForUserInTeam

default ApiResponse<PostList> getFlaggedPostsForUserInTeam(String userId,
                                                           String teamId)

returns flagged posts in team of a user based on user id string.

getFlaggedPostsForUserInTeam

ApiResponse<PostList> getFlaggedPostsForUserInTeam(String userId,
                                                   String teamId,
                                                   Pager pager)

returns flagged posts in team of a user based on user id string.

getFlaggedPostsForUserInChannel

default ApiResponse<PostList> getFlaggedPostsForUserInChannel(String userId,
                                                              String channelId)

returns flagged posts in channel of a user based on user id string.

getFlaggedPostsForUserInChannel

ApiResponse<PostList> getFlaggedPostsForUserInChannel(String userId,
                                                      String channelId,
                                                      Pager pager)

returns flagged posts in channel of a user based on user id string.

getPostsSince

default ApiResponse<PostList> getPostsSince(String channelId,
                                            Date since)

gets posts created after a specified time as Unix time in milliseconds.

getPostsSince

default ApiResponse<PostList> getPostsSince(String channelId,
                                            ZonedDateTime since)

gets posts created after a specified time as Unix time in milliseconds.

getPostsSince

ApiResponse<PostList> getPostsSince(String channelId,
                                    long since)

gets posts created after a specified time as Unix time in milliseconds.

getPostsAfter

default ApiResponse<PostList> getPostsAfter(String channelId,
                                            String postId)

gets a page of posts that were posted after the post provided.

getPostsAfter

default ApiResponse<PostList> getPostsAfter(String channelId,
                                            String postId,
                                            Pager pager)

gets a page of posts that were posted after the post provided.

getPostsAfter

ApiResponse<PostList> getPostsAfter(String channelId,
                                    String postId,
                                    Pager pager,
                                    String etag)

gets a page of posts that were posted after the post provided.

getPostsBefore

default ApiResponse<PostList> getPostsBefore(String channelId,
                                             String postId)

gets a page of posts that were posted before the post provided.

getPostsBefore

default ApiResponse<PostList> getPostsBefore(String channelId,
                                             String postId,
                                             Pager pager)

gets a page of posts that were posted before the post provided.

getPostsBefore

ApiResponse<PostList> getPostsBefore(String channelId,
                                     String postId,
                                     Pager pager,
                                     String etag)

gets a page of posts that were posted before the post provided.

searchPosts

default ApiResponse<PostSearchResults> searchPosts(String teamId,
                                                   String terms)

returns any posts with matching term string.

searchPosts

ApiResponse<PostSearchResults> searchPosts(String teamId,
                                           String terms,
                                           boolean isOrSearch)

returns any posts with matching term string.

getFileInfoForPost

ApiResponse<FileInfo[]> getFileInfoForPost(String postId)

get a list of file info attached the post.