Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixing HeaderDoc invalid documentation #298

Merged
merged 2 commits into from
Jan 31, 2016
Merged

Fixing HeaderDoc invalid documentation #298

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50fb661
Enabling documentation warnings, and fixing HeaderDoc invalid documen…
Jan 31, 2016
0862500
Update project.pbxproj
Jan 31, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 6 additions & 18 deletions OnePasswordExtension.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,7 @@ NS_ASSUME_NONNULL_BEGIN

@param sender The sender which triggers the share sheet to show. UIButton, UIBarButtonItem or UIView. Can also be nil on iPhone, but not on iPad.

@param LoginDictionary Reply parameter that contains the username, password and the One-Time Password if available.

@param error Reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
@param completion A completion block called with two parameters loginDictionary and error once completed. The loginDictionary reply parameter that contains the username, password and the One-Time Password if available. The error Reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
*/
- (void)findLoginForURLString:(nonnull NSString *)URLString forViewController:(nonnull UIViewController *)viewController sender:(nullable id)sender completion:(nullable void (^)(NSDictionary * __nullable loginDictionary, NSError * __nullable error))completion;

Expand All @@ -115,9 +113,7 @@ NS_ASSUME_NONNULL_BEGIN

@param sender The sender which triggers the share sheet to show. UIButton, UIBarButtonItem or UIView. Can also be nil on iPhone, but not on iPad.

@param LoginDictionary Reply parameter which contain all the information about the newly saved Login. Use the `Login Dictionary keys` above to extract the needed information and update your UI. For example, updating the UI with the newly generated password lets the user know their action was successful.

@param error Reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
@param completion A completion block which is called with type parameters loginDictionary and error. The loginDictionary peply parameter which contain all the information about the newly saved Login. Use the `Login Dictionary keys` above to extract the needed information and update your UI. For example, updating the UI with the newly generated password lets the user know their action was successful. The error reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
*/
- (void)storeLoginForURLString:(nonnull NSString *)URLString loginDetails:(nullable NSDictionary *)loginDetailsDictionary passwordGenerationOptions:(nullable NSDictionary *)passwordGenerationOptions forViewController:(nonnull UIViewController *)viewController sender:(nullable id)sender completion:(nullable void (^)(NSDictionary * __nullable loginDictionary, NSError * __nullable error))completion;

Expand Down Expand Up @@ -145,9 +141,7 @@ NS_ASSUME_NONNULL_BEGIN

@param sender The sender which triggers the share sheet to show. UIButton, UIBarButtonItem or UIView. Can also be nil on iPhone, but not on iPad.

@param LoginDictionary Reply parameter which contain all the information about the newly updated Login, including the newly generated and the old password. Use the `Login Dictionary keys` above to extract the needed information and update your UI. For example, updating the UI with the newly generated password lets the user know their action was successful.

@param error Reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
@param completion A completion block which is called with type parameters loginDictionary and error. The loginDictionary reply parameter which contain all the information about the newly updated Login, including the newly generated and the old password. Use the `Login Dictionary keys` above to extract the needed information and update your UI. For example, updating the UI with the newly generated password lets the user know their action was successful. The error reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
*/
- (void)changePasswordForLoginForURLString:(nonnull NSString *)URLString loginDetails:(nullable NSDictionary *)loginDetailsDictionary passwordGenerationOptions:(nullable NSDictionary *)passwordGenerationOptions forViewController:(UIViewController *)viewController sender:(nullable id)sender completion:(nullable void (^)(NSDictionary * __nullable loginDictionary, NSError * __nullable error))completion;

Expand All @@ -167,9 +161,7 @@ NS_ASSUME_NONNULL_BEGIN

@param yesOrNo Boolean flag. If YES is passed only matching Login items will be shown, otherwise the 1Password Extension will also display Credit Cards and Identities.

@param success Reply parameter that is YES if the 1Password Extension has been successfully completed or NO otherwise.

@param error Reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
@param completion Completion block called on completion with parameters success, and error. The success reply parameter that is YES if the 1Password Extension has been successfully completed or NO otherwise. The error reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
*/
- (void)fillItemIntoWebView:(nonnull id)webView forViewController:(nonnull UIViewController *)viewController sender:(nullable id)sender showOnlyLogins:(BOOL)yesOrNo completion:(nullable void (^)(BOOL success, NSError * __nullable error))completion;

Expand All @@ -187,9 +179,7 @@ NS_ASSUME_NONNULL_BEGIN

@param webView The web view which displays the form to be filled. The active UIWebView Or WKWebView. Must not be nil.

@param extensionItem Reply parameter that is contains all the info required by the 1Password extension if has been successfully completed or nil otherwise.

@param error Reply parameter that is nil if the 1Password extension item has been successfully created, or it contains error information about the completion failure.
@param completion Completion block called on completion with extensionItem and error. The extensionItem reply parameter that is contains all the info required by the 1Password extension if has been successfully completed or nil otherwise. The error reply parameter that is nil if the 1Password extension item has been successfully created, or it contains error information about the completion failure.
*/
- (void)createExtensionItemForWebView:(nonnull id)webView completion:(void (^)(NSExtensionItem * __nullable extensionItem, NSError * __nullable error))completion;

Expand All @@ -199,9 +189,7 @@ NS_ASSUME_NONNULL_BEGIN
@param returnedItems Array which contains the selected activity in the share sheet. Empty array if the share sheet is cancelled by the user.
@param webView The web view which displays the form to be filled. The active UIWebView Or WKWebView. Must not be nil.

@param success Reply parameter that is YES if the 1Password Extension has been successfully completed or NO otherwise.

@param error Reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
@param completion Completion block called on completion with parameters success, and error. The success reply parameter that is YES if the 1Password Extension has been successfully completed or NO otherwise. The error reply parameter that is nil if the 1Password Extension has been successfully completed, or it contains error information about the completion failure.
*/
- (void)fillReturnedItems:(nullable NSArray *)returnedItems intoWebView:(nonnull id)webView completion:(nullable void (^)(BOOL success, NSError * __nullable error))completion;

Expand Down