File: file.client.html

package info (click to toggle)
ruby-oauth2 2.0.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,608 kB
  • sloc: ruby: 5,441; javascript: 529; makefile: 4; sh: 4
file content (121 lines) | stat: -rw-r--r-- 4,031 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  File: client
  
    &mdash; Documentation by YARD 0.9.37
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" />

  <link rel="stylesheet" href="css/common.css" type="text/css" />

<script type="text/javascript">
  pathId = "client";
  relpath = '';
</script>


  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="file_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
  
    <a href="_index.html">Index</a> &raquo; 
    <span class="title">File: client</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><div id='filecontents'><p>module OAuth2<br>
  class Client<br>
    RESERVED_REQ_KEYS: Array[String]<br>
    RESERVED_PARAM_KEYS: Array[String]</p>

<pre class="code ruby"><code class="ruby">include OAuth2::FilteredAttributes

attr_reader id: String
attr_reader secret: String
attr_reader site: String?
attr_accessor options: Hash[Symbol, untyped]
attr_writer connection: untyped

def initialize: (String client_id, String client_secret, ?Hash[Symbol, untyped]) { (untyped) -&gt; void } -&gt; void

def site=: (String) -&gt; String

def connection: () -&gt; untyped

def authorize_url: (?Hash[untyped, untyped]) -&gt; String
def token_url: (?Hash[untyped, untyped]) -&gt; String
def revoke_url: (?Hash[untyped, untyped]) -&gt; String

def request: (Symbol verb, String url, ?Hash[Symbol, untyped]) { (untyped) -&gt; void } -&gt; OAuth2::Response

def get_token: (Hash[untyped, untyped] params, ?Hash[Symbol, untyped] access_token_opts, ?Proc) { (Hash[Symbol, untyped]) -&gt; void } -&gt; (OAuth2::AccessToken | nil)

def revoke_token: (String token, ?String token_type_hint, ?Hash[Symbol, untyped]) { (untyped) -&gt; void } -&gt; OAuth2::Response

def http_method: () -&gt; Symbol

def auth_code: () -&gt; OAuth2::Strategy::AuthCode
def implicit: () -&gt; OAuth2::Strategy::Implicit
def password: () -&gt; OAuth2::Strategy::Password
def client_credentials: () -&gt; OAuth2::Strategy::ClientCredentials
def assertion: () -&gt; OAuth2::Strategy::Assertion

def redirection_params: () -&gt; Hash[String, String]

private

def params_to_req_opts: (Hash[untyped, untyped]) -&gt; Hash[Symbol, untyped]
def parse_snaky_params_headers: (Hash[untyped, untyped]) -&gt; [Symbol, bool, untyped, (Symbol | nil), Hash[untyped, untyped], Hash[String, String]]
def execute_request: (Symbol verb, String url, ?Hash[Symbol, untyped]) { (Faraday::Request) -&gt; void } -&gt; OAuth2::Response
def authenticator: () -&gt; OAuth2::Authenticator
def parse_response_legacy: (OAuth2::Response, Hash[Symbol, untyped], Proc) -&gt; (OAuth2::AccessToken | nil)
def parse_response: (OAuth2::Response, Hash[Symbol, untyped]) -&gt; (OAuth2::AccessToken | nil)
def build_access_token: (OAuth2::Response, Hash[Symbol, untyped], untyped) -&gt; OAuth2::AccessToken
def build_access_token_legacy: (OAuth2::Response, Hash[Symbol, untyped], Proc) -&gt; (OAuth2::AccessToken | nil)
def oauth_debug_logging: (untyped) -&gt; void   end end
</code></pre>
</div></div>

      <div id="footer">
  Generated on Mon Sep 15 21:28:40 2025 by
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.9.37 (ruby-3.4.5).
</div>

    </div>
  </body>
</html>