AppAuth: Protocol Reference (original) (raw)
An external user-agent UI that presents displays the request to the user. Clients may provide custom implementations of an external user-agent to customize the way the requests are presented to the end user. More...
#import <[OIDExternalUserAgent.h](%5Fo%5Fi%5Fd%5Fexternal%5Fuser%5Fagent%5F8h%5Fsource.html)>
| Instance Methods | |
|---|---|
| (BOOL) | - presentExternalUserAgentRequest:session: |
| Presents the request in the external user-agent. More... | |
| (void) | - dismissExternalUserAgentAnimated:completion: |
| Dimisses the external user-agent and calls completion when the dismiss operation ends. More... | |
An external user-agent UI that presents displays the request to the user. Clients may provide custom implementations of an external user-agent to customize the way the requests are presented to the end user.
An interface that any external user-agent request may implement to use the [OIDExternalUserAgent](protocol%5Fo%5Fi%5Fd%5Fexternal%5Fuser%5Fagent-p.html "An external user-agent UI that presents displays the request to the user. Clients may provide custom ...") flow.
◆ dismissExternalUserAgentAnimated:completion:()
| - (void) dismissExternalUserAgentAnimated: | (BOOL) | animated |
|---|---|---|
| completion: | (void(^)(void)) | completion |
Dimisses the external user-agent and calls completion when the dismiss operation ends.
Parameters
| animated | Whether or not the dismiss operation should be animated. |
|---|
Parameters
| completion | The block to be called when the dismiss operations ends |
|---|
◆ presentExternalUserAgentRequest:session:()
Presents the request in the external user-agent.
Parameters
| request | The request to be presented in the external user-agent. |
|---|---|
| session | The OIDExternalUserAgentSession instance that initiates presenting the UI. Concrete implementations of a OIDExternalUserAgent may call resumeExternalUserAgentFlowWithURL or failExternalUserAgentFlowWithError on session to either resume or fail the request. |
Returns
YES If the request UI was successfully presented to the user.
The documentation for this protocol was generated from the following file:
- Source/OIDExternalUserAgent.h