org.telegram.telegrambots.meta.api.objects.UsersShared Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of telegrambots-meta Show documentation

Easy to use library to create Telegram Bots

There is a newer version: 7.10.0

package org.telegram.telegrambots.meta.api.objects;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.ToString;
import lombok.experimental.SuperBuilder;
import lombok.extern.jackson.Jacksonized;
import org.telegram.telegrambots.meta.api.interfaces.BotApiObject;

import java.util.List;
import java.util.stream.Collectors;

/**
 * @author Ruben Bermudez
 * @version 7.0
 * This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.
 */
@EqualsAndHashCode(callSuper = false)
@Getter
@Setter
@ToString
@RequiredArgsConstructor
@AllArgsConstructor
@SuperBuilder
@Jacksonized
@JsonIgnoreProperties(ignoreUnknown = true)
public class UsersShared implements BotApiObject {
    private static final String REQUEST_ID_FIELD = "request_id";
    private static final String USERS_FIELD = "users";

    /**
     * Identifier of the request
     */
    @JsonProperty(REQUEST_ID_FIELD)
    private String requestId;
    /**
     * Information about users shared with the bot.
     */
    @JsonProperty(USERS_FIELD)
    private List users;

    /**
     * Use {{@link UsersShared#getUsers()}}
     */
    @Deprecated
    @JsonIgnore
    public List getUserIds() {
        if (users == null) {
            return null;
        }
        return users.stream().map(UserShared::getUserId).collect(Collectors.toList());
    }
}