Class TdApi.GetLoginUrl

  • Enclosing class:
    TdApi

    public static class TdApi.GetLoginUrl
    extends TdApi.Function
    Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button.

    Returns HttpUrl

    • Field Summary

      Fields 
      Modifier and Type Field Description
      boolean allowWriteAccess
      True, if the user allowed the bot to send them messages.
      long buttonId
      Button identifier.
      long chatId
      Chat identifier of the message with the button.
      static int CONSTRUCTOR
      Identifier uniquely determining type of the object.
      long messageId
      Message identifier of the message with the button.
    • Constructor Summary

      Constructors 
      Constructor Description
      GetLoginUrl()
      Default constructor for a function, which returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl.
      GetLoginUrl​(long chatId, long messageId, long buttonId, boolean allowWriteAccess)
      Creates a function, which returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl.
    • Field Detail

      • chatId

        public long chatId
        Chat identifier of the message with the button.
      • messageId

        public long messageId
        Message identifier of the message with the button.
      • buttonId

        public long buttonId
        Button identifier.
      • allowWriteAccess

        public boolean allowWriteAccess
        True, if the user allowed the bot to send them messages.
      • CONSTRUCTOR

        public static final int CONSTRUCTOR
        Identifier uniquely determining type of the object.
        See Also:
        Constant Field Values
    • Constructor Detail

      • GetLoginUrl

        public GetLoginUrl()
        Default constructor for a function, which returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button.

        Returns HttpUrl

      • GetLoginUrl

        public GetLoginUrl​(long chatId,
                           long messageId,
                           long buttonId,
                           boolean allowWriteAccess)
        Creates a function, which returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button.

        Returns HttpUrl

        Parameters:
        chatId - Chat identifier of the message with the button.
        messageId - Message identifier of the message with the button.
        buttonId - Button identifier.
        allowWriteAccess - True, if the user allowed the bot to send them messages.