W3cubDocs

/Crystal 0.31

abstract class OAuth2::AccessToken

Overview

Base class for the two possible access tokens: Bearer and Mac.

Use #authenticate to authenticate an HTTP::Client.

Direct Known Subclasses

Defined in:

oauth2/access_token/access_token.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(access_token : String, expires_in : Int?, refresh_token : String? = nil, scope : String? = nil, extra = nil)Source

def self.new(pull : JSON::PullParser)Source

Instance Method Detail

def access_token : StringSource

def access_token=(access_token : String)Source

abstract def authenticate(request : HTTP::Request, tls)Source

def authenticate(client : HTTP::Client)Source

def expires_in : Int64?Source

def expires_in=(expires_in : Int64?)Source

def extra : Hash(String, String)?Source

JSON key-value pairs that are outside of the OAuth2 spec are stored in this property in case they are needed. Their value is the raw JSON string found in the JSON value (with possible changes in the string format, but preserving JSON semantic). For example if the value was [1, 2, 3] then the value in this hash will be the string "[1,2,3]".

def extra=(extra : Hash(String, String)?)Source

JSON key-value pairs that are outside of the OAuth2 spec are stored in this property in case they are needed. Their value is the raw JSON string found in the JSON value (with possible changes in the string format, but preserving JSON semantic). For example if the value was [1, 2, 3] then the value in this hash will be the string "[1,2,3]".

def refresh_token : String?Source

def refresh_token=(refresh_token : String?)Source

def scope : String?Source

def scope=(scope : String?)Source

© 2012–2019 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.31.1/OAuth2/AccessToken.html