gnustep-base-doc 1.24.7-1build2 / usr / share / GNUstep / Documentation / Developer / Base / Reference / NSURLAuthenticationChallenge.html

This file is indexed.

/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSURLAuthenticationChallenge.html is in gnustep-base-doc 1.24.7-1build2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

    <head>
    <title>NSURLAuthenticationChallenge class documentation</title>
  </head>
  <body>
    <font face="serif">
    <a href="Base.html">Up</a>
    <br />
    <h1><a name="title$NSURLAuthenticationChallenge">NSURLAuthenticationChallenge class documentation</a></h1>
    <h3>Authors</h3>
    <dl>
      <dt>Generated by root</dt>
      <dd>
      </dd>
    </dl>

        <div>
      <hr width="50%" align="left" />
      <h3>Contents -</h3>
      <ol>
        <li>
          <a href="#001000000000">Software documentation for the
        NSURLAuthenticationChallenge class</a>
        </li>
        <li>
          <a href="#002000000000">Software documentation for the
        NSURLAuthenticationChallengeSender
        protocol</a>
        </li>
      </ol>
      <hr width="50%" align="left" />
    </div>

          <h1><a name="001000000000">
        Software documentation for the
        NSURLAuthenticationChallenge class
      </a></h1>
    <h2><a name="class$NSURLAuthenticationChallenge">NSURLAuthenticationChallenge</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSURLAuthenticationChallenge.h</dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
          <strong>Class</strong> to represent an
          authentication challenge and indicate when the
          challenge is complete.
        
    </div>
    <hr width="50%" align="left" />
    <a href="#_NSURLAuthenticationChallenge_ivars">Instance Variables</a>
    <br/><br/>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-error">-error</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-failureResponse">-failureResponse</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-initWithAuthenticationChallenge$sender$">-initWithAuthenticationChallenge:sender:</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-initWithProtectionSpace$proposedCredential$previousFailureCount$failureResponse$error$sender$">-initWithProtectionSpace:proposedCredential:previousFailureCount:failureResponse:error:sender:</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-previousFailureCount">-previousFailureCount</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-proposedCredential">-proposedCredential</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-protectionSpace">-protectionSpace</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$NSURLAuthenticationChallenge-sender">-sender</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-error">error&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>*) <b>error</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Returns the error with which the reciver was
            initialised or <code>nil</code> if it was not
            initialised with an error. <br /> The error may
            indicate the nature of the authentication failure.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-failureResponse">failureResponse&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSURLResponse.html#class$NSURLResponse">NSURLResponse</a>*) <b>failureResponse</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Returns the response with which the receiver was
            initialised. <br /> This response contains the
            authentication failure corresponding to this
            challenge object. <br /> If there was no failure
            or response, returns <code>nil</code>.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-initWithAuthenticationChallenge$sender$">initWithAuthenticationChallenge:&nbsp;sender:&nbsp;</a></h3>
    - (id) <b>initWithAuthenticationChallenge:</b> (<a rel="gsdoc" href="#class$NSURLAuthenticationChallenge">NSURLAuthenticationChallenge</a>*)challenge<b> sender:</b> (id<<a rel="gsdoc" href="#protocol$(NSURLAuthenticationChallengeSender)">NSURLAuthenticationChallengeSender</a>>)sender;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Initialises a new <var>challenge</var> by
            copying information from an old one.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-initWithProtectionSpace$proposedCredential$previousFailureCount$failureResponse$error$sender$">initWithProtectionSpace:&nbsp;proposedCredential:&nbsp;previousFailureCount:&nbsp;failureResponse:&nbsp;error:&nbsp;sender:&nbsp;</a></h3>
    - (id) <b>initWithProtectionSpace:</b> (<a rel="gsdoc" href="NSURLProtectionSpace.html#class$NSURLProtectionSpace">NSURLProtectionSpace</a>*)space<b> proposedCredential:</b> (<a rel="gsdoc" href="NSURLCredential.html#class$NSURLCredential">NSURLCredential</a>*)credential<b> previousFailureCount:</b> (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>)previousFailureCount<b> failureResponse:</b> (<a rel="gsdoc" href="NSURLResponse.html#class$NSURLResponse">NSURLResponse</a>*)response<b> error:</b> (<a rel="gsdoc" href="NSError.html#class$NSError">NSError</a>*)error<b> sender:</b> (id<<a rel="gsdoc" href="#protocol$(NSURLAuthenticationChallengeSender)">NSURLAuthenticationChallengeSender</a>>)sender;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Returns the receiver initialised in the specified
            protection <var>space</var> and with the
            specified <var>credential</var>. The
            <var>previousFailureCount</var> says how many
            requests have failed the challenge and
            <var>response</var> provide information about the
            last failure (which caused this challenge to be
            created). <br /> The <var>error</var> provides
            information about the authentication failure
            and the <var>sender</var> is the object to receive
            callbacks.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-previousFailureCount">previousFailureCount&nbsp;</a></h3>
    - (<a rel="gsdoc" href="TypesAndConstants.html#type$NSInteger">NSInteger</a>) <b>previousFailureCount</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Returns the count of failed authentication
            attempts.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-proposedCredential">proposedCredential&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSURLCredential.html#class$NSURLCredential">NSURLCredential</a>*) <b>proposedCredential</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Returns a proposed credential to answer the
            challenge. <br /> If there is no credential
            available, this returns <code>nil</code>. <br />
            The credential may come from storage or from the URL
            itsself.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-protectionSpace">protectionSpace&nbsp;</a></h3>
    - (<a rel="gsdoc" href="NSURLProtectionSpace.html#class$NSURLProtectionSpace">NSURLProtectionSpace</a>*) <b>protectionSpace</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Returns the protection space needing
            authentication.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$NSURLAuthenticationChallenge-sender">sender&nbsp;</a></h3>
    - (id<<a rel="gsdoc" href="#protocol$(NSURLAuthenticationChallengeSender)">NSURLAuthenticationChallengeSender</a>>) <b>sender</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Returns the sender of the challenge... the object
            to which callbacks should be made while processing the
            challenge.
          
    </div>
    <hr width="25%" align="left" />
</div>
<a name="_NSURLAuthenticationChallenge_ivars"/>    <br/><hr width="50%" align="left" />
    <h2>Instance Variables for NSURLAuthenticationChallenge Class</h2>
    <h3><a name="ivariable$NSURLAuthenticationChallenge*_NSURLAuthenticationChallengeInternal">_NSURLAuthenticationChallengeInternal</a></h3>
    @protected void* <b>_NSURLAuthenticationChallengeInternal</b>;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            <em>Warning</em> the underscore at the start of the
            name of this instance variable indicates that, even
            though it is not technically <em>private</em>, it is
            intended for internal use within the package, and
            you should not use the variable in other code.
          
    </div>
    <hr width="25%" align="left" />
    <br/><hr width="50%" align="left" /><br/>

          <h1><a name="002000000000">
        Software documentation for the
        NSURLAuthenticationChallengeSender
        protocol
      </a></h1>
    <h2><a name="protocol$(NSURLAuthenticationChallengeSender)">NSURLAuthenticationChallengeSender</a></h2>
    <blockquote class="declared">
      <dl>
        <dt><b>Declared in:</b></dt>
        <dd>Foundation/NSURLAuthenticationChallenge.h</dd>
      </dl>
    </blockquote>
    <blockquote>
      <dl>
        <dt><b>Conforms to:</b></dt>
        <dd><a rel="gsdoc" href="NSObject.html#protocol$(NSObject)">NSObject</a></dd>
      </dl>
    </blockquote>
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
          A challenge sender (usually an NSURLProtocol subclass
          handling a connection/download) provides these
          methods to permit a client to control authentication.
        
    </div>
    <b>Method summary</b>
    <ul>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$(NSURLAuthenticationChallengeSender)-cancelAuthenticationChallenge$">-cancelAuthenticationChallenge:</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$(NSURLAuthenticationChallengeSender)-continueWithoutCredentialForAuthenticationChallenge$">-continueWithoutCredentialForAuthenticationChallenge:</a></li>
      <li><a rel="gsdoc" href="NSURLAuthenticationChallenge.html#method$(NSURLAuthenticationChallengeSender)-useCredential$forAuthenticationChallenge$">-useCredential:forAuthenticationChallenge:</a></li>
    </ul>
    <hr width="50%" align="left" />
<div class="method">
    <h3><a name="method$(NSURLAuthenticationChallengeSender)-cancelAuthenticationChallenge$">cancelAuthenticationChallenge:&nbsp;</a></h3>
    - (void) <b>cancelAuthenticationChallenge:</b> (<a rel="gsdoc" href="#class$NSURLAuthenticationChallenge">NSURLAuthenticationChallenge</a>*)challenge;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Cancels the authenticatiopn <var>challenge</var>,
            ensuring that the load operation will fail to
            retrieve data, completing with only the response
            headers containing the <var>challenge</var> having
            been read from the server.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$(NSURLAuthenticationChallengeSender)-continueWithoutCredentialForAuthenticationChallenge$">continueWithoutCredentialForAuthenticationChallenge:&nbsp;</a></h3>
    - (void) <b>continueWithoutCredentialForAuthenticationChallenge:</b> (<a rel="gsdoc" href="#class$NSURLAuthenticationChallenge">NSURLAuthenticationChallenge</a>*)challenge;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Tells the sender to continue the load without
            providing a new credential for it to use... if
            the <var>challenge</var> already had a proposed
            credential, the sender may elect to use it.
          
    </div>
    <hr width="25%" align="left" />
</div>
<div class="method">
    <h3><a name="method$(NSURLAuthenticationChallengeSender)-useCredential$forAuthenticationChallenge$">useCredential:&nbsp;forAuthenticationChallenge:&nbsp;</a></h3>
    - (void) <b>useCredential:</b> (<a rel="gsdoc" href="NSURLCredential.html#class$NSURLCredential">NSURLCredential</a>*)credential<b> forAuthenticationChallenge:</b> (<a rel="gsdoc" href="#class$NSURLAuthenticationChallenge">NSURLAuthenticationChallenge</a>*)challenge;<br />
    <div class="availability">
<b>Availability:</b> MacOS-X 10.2.0, Base 1.13.0</div>
<br />
    <div class="desc">
      
            Tells the sender to continue the load using the new
            <var>credential</var> provided by this method.
          
    </div>
    <hr width="25%" align="left" />
</div>
    <br />
    <a href="Base.html">Up</a>
    </font>
</body>
</html>

APT Browse - Built by Thomas Orozco.