Structures

The following structures are available globally.

  • JWT

    Represents a JSON Web Token object. Use this struct to get and verify JWT tokens. If the user authorizes your app with the .openID permission, a signed ID token will be issued together with an access token. The LINE SDK verifies JWT tokens for you.

    See more

    Declaration

    Swift

    public struct JWT : Equatable
  • Represents a request for getting the friendship status of the user and the bot linked to your LINE Login channel.

    See more

    Declaration

    Swift

    public struct GetBotFriendshipStatusRequest : Request
  • Warning

    Deprecated. Use LoginManager.Parameters type instead.

    Represents options for logging in to the LINE Platform using the LoginManager class.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "Use `LoginManager.Parameters` type instead.")
    public struct LoginManagerOptions : OptionSet
  • Represents the possible login permissions to be set in the authorization request.

    See more

    Declaration

    Swift

    public struct LoginPermission : Hashable
  • Represents a successful login.

    See more

    Declaration

    Swift

    public struct LoginResult
    extension LoginResult: Encodable
  • Represents an access token which is used to access the LINE Platform. Most API calls to the LINE Platform require an access token as evidence of successful authorization. A valid access token is issued after the user grants your app the permissions that your app requests. An access token is bound to permissions (scopes) that define the API endpoints that you can access. Choose the permissions for your channel in the LINE Developers site and set them in the login method used in your app.

    An access token will expire after a certain period. Check the expiresAt property, which contains the expiration time calculated with the local time setting. Any API call will attempt to refresh the access token if necessary, when it requires authorization.

    By default, the LINE SDK stores an access token in the keychain for your app and obtains authorization when you access the LINE Platform through the framework request methods.

    Do not try to create an access token yourself. You can get a valid access token in use by accessing the current property of an AccessTokenStore object.

    See more

    Declaration

    Swift

    public struct AccessToken : Codable, AccessTokenType, Equatable
  • Possible keys in the userInfo property of notifications related to the LINE Platform.

    See more

    Declaration

    Swift

    public struct LineSDKNotificationKey
  • Represents a response to the GetVerifyTokenRequest method.

    See more

    Declaration

    Swift

    public struct AccessTokenVerifyResult : Codable
  • Represents a response to the GetUserProfileRequest method.

    See more

    Declaration

    Swift

    public struct UserProfile : Codable
  • Represents a request for getting the user’s profile.

    Declaration

    Swift

    public struct GetUserProfileRequest : Request
  • Represents a request for verifying an access token.

    See more

    Declaration

    Swift

    public struct GetVerifyTokenRequest : Request
  • Provides an easy way to create a RequestAdapter object with a block.

    See more

    Declaration

    Swift

    public struct AnyRequestAdapter : RequestAdapter
  • Represents an API error that occurs when interacting with the LINE Platform. If the LINE Platform returns an error in a known format, the error is parsed into an APIError object and thrown out. The error type is LineSDKError.responseFailed with .invalidHTTPStatusAPIError.

    See more

    Declaration

    Swift

    public struct APIError
  • Represents a color in hexadecimal notation. This type provides compatibility with the Codable protocol for color objects.

    See more

    Declaration

    Swift

    public struct HexColor : Codable
  • Represents a signal of some event. It is a decodable version of Void.

    Declaration

    Swift

    public struct Unit : Decodable
  • Constants used in the LINE SDK.

    See more

    Declaration

    Swift

    public struct Constant