Conforms to RCTBridgeModule
Declared in RCTURLRequestHandler.h

Overview

Provides the interface needed to register a request handler. Request handlers are also bridge modules, so should be registered using RCT_EXPORT_MODULE().

Tasks

  • – canHandleRequest:

    Indicates whether this handler is capable of processing the specified request. Typically the handler would examine the scheme/protocol of the request URL (and possibly the HTTP method and/or headers) to determine this.

    required method
  • – sendRequest:withDelegate:

    Send a network request and call the delegate with the response data. The method should return a token, which can be anything, including the request itself. This will be used later to refer to the request in callbacks. The sendRequest:withDelegate: method must return before calling any of the delegate methods, or the delegate won’t recognize the token.

    required method
  • – cancelRequest:

    Not all request types can be cancelled, but this method can be implemented for ones that can. It should be used to free up any resources on ongoing processes associated with the request.

  • – handlerPriority

    If more than one RCTURLRequestHandler responds YES to canHandleRequest: then handlerPriority is used to determine which one to use. The handler with the highest priority will be selected. Default priority is zero. If two or more valid handlers have the same priority, the selection order is undefined.

Instance Methods

canHandleRequest:

- (BOOL)canHandleRequest:(NSURLRequest *)request
Discussion

Indicates whether this handler is capable of processing the specified request. Typically the handler would examine the scheme/protocol of the request URL (and possibly the HTTP method and/or headers) to determine this.

Declared In

RCTURLRequestHandler.h

cancelRequest:

- (void)cancelRequest:(id)requestToken
Discussion

Not all request types can be cancelled, but this method can be implemented for ones that can. It should be used to free up any resources on ongoing processes associated with the request.

Declared In

RCTURLRequestHandler.h

handlerPriority

- (float)handlerPriority
Discussion

If more than one RCTURLRequestHandler responds YES to canHandleRequest: then handlerPriority is used to determine which one to use. The handler with the highest priority will be selected. Default priority is zero. If two or more valid handlers have the same priority, the selection order is undefined.

Declared In

RCTURLRequestHandler.h

sendRequest:withDelegate:

- (id)sendRequest:(NSURLRequest *)request withDelegate:(id<RCTURLRequestDelegate>)delegate
Discussion

Send a network request and call the delegate with the response data. The method should return a token, which can be anything, including the request itself. This will be used later to refer to the request in callbacks. The sendRequest:withDelegate: method must return before calling any of the delegate methods, or the delegate won’t recognize the token.

Declared In

RCTURLRequestHandler.h