Package dev.voroby.springframework.telegram.client.templates

Class UserTemplate

java.lang.Object

dev.voroby.springframework.telegram.client.templates.UserTemplate

public class UserTemplate
extends Object

This class simplifies the use of TelegramClient for TdApi.User related objects.

Author:

Pavel Vorobyev

Constructor Summary

Constructors

Constructor	Description
UserTemplate(TelegramClient telegramClient)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Response<TdApi.User>>	getMe()	Returns the current user.
CompletableFuture<Response<TdApi.ProfilePhoto>>	getProfilePhoto(long userId)	Returns profile photo of the user.
CompletableFuture<Response<TdApi.ChatPhoto>>	getPublicPhoto(long userId)	Returns user profile photo visible if the main photo is hidden by privacy settings.
CompletableFuture<Response<TdApi.User>>	getUser(long userId)	Returns information about a user by their identifier.
CompletableFuture<Response<TdApi.UserFullInfo>>	getUserFullInfo(long userId)	Returns full information about a user by their identifier.
CompletableFuture<Response<TdApi.UserLink>>	getUserLink()	Returns an HTTPS link, which can be used to get information about the current user.
CompletableFuture<Response<TdApi.ChatPhotos>>	getUserProfilePhotos(long userId, int offset, int limit)	Returns the profile photos of a user.
CompletableFuture<Response<TdApi.User>>	searchUserByPhoneNumber(String phoneNumber)	Searches a user by their phone number.
CompletableFuture<Response<TdApi.User>>	searchUserByUsername(String username)	Searches a user by username.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserTemplate

public UserTemplate(TelegramClient telegramClient)

Method Details

getUser

public CompletableFuture<Response<TdApi.User>> getUser(long userId)

Returns information about a user by their identifier. This is an offline request.

Parameters:

userId - User identifier.

Returns:

CompletableFuture<Response<TdApi.User>>.

getUserFullInfo

public CompletableFuture<Response<TdApi.UserFullInfo>> getUserFullInfo(long userId)

Returns full information about a user by their identifier.

Parameters:

userId - User identifier.

Returns:

CompletableFuture<Response<TdApi.UserFullInfo>>.

getUserLink

public CompletableFuture<Response<TdApi.UserLink>> getUserLink()

Returns an HTTPS link, which can be used to get information about the current user.

Returns:

CompletableFuture<Response<TdApi.UserLink>>.

getMe

public CompletableFuture<Response<TdApi.User>> getMe()

Returns the current user.

Returns:

CompletableFuture<Response<TdApi.User>>.

getProfilePhoto

public CompletableFuture<Response<TdApi.ProfilePhoto>> getProfilePhoto(long userId)

Returns profile photo of the user. May be null.

Parameters:

userId - User identifier.

Returns:

CompletableFuture<Response<TdApi.ProfilePhoto>>. TdApi.ProfilePhoto may be null.

getPublicPhoto

public CompletableFuture<Response<TdApi.ChatPhoto>> getPublicPhoto(long userId)

Returns user profile photo visible if the main photo is hidden by privacy settings. May be null.

Parameters:

userId - User identifier.

Returns:

CompletableFuture<Response<TdApi.ChatPhoto>>. TdApi.ChatPhoto may be null.

getUserProfilePhotos

public CompletableFuture<Response<TdApi.ChatPhotos>> getUserProfilePhotos(long userId,
 int offset,
 int limit)

Returns the profile photos of a user. Personal and public photo aren't returned.

Parameters:

userId - User identifier.

offset - The number of photos to skip; must be non-negative.

limit - The maximum number of photos to be returned; up to 100.

Returns:

CompletableFuture<Response<TdApi.ChatPhotos>>.

searchUserByPhoneNumber

public CompletableFuture<Response<TdApi.User>> searchUserByPhoneNumber(String phoneNumber)

Searches a user by their phone number. Returns null if user can't be found.

Parameters:

phoneNumber - Phone number in international format to search for.

Returns:

CompletableFuture<Response<TdApi.User>>. TdApi.User may be null.

searchUserByUsername

public CompletableFuture<Response<TdApi.User>> searchUserByUsername(String username)

Searches a user by username. Returns null if user can't be found.

Parameters:

username - Username to search for.

Returns:

CompletableFuture<Response<TdApi.User>>. TdApi.User may be null.