Skip to content

ECP/ECPInterAppToolkit

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

ECPInterAppToolkit

PhotoToaster registers the phototoaster-x-callback:// URL scheme and supports for integration with other apps via the x-callback-url protocol. The format for a URL action looks like this:

phototoaster-x-callback://x-callback-url/[action]?[action parameters]&[x-callback parameters]

Supported x-callback parameters: x-source, x-success, x-error and x-cancel.

##Actions ###/returnEditedClipboardImage

Open the image on the clipboard for editing and return the edited results via the clipboard. Not setting a source makes this a not so interesting call.

####Parameters

preset (optional) A preset that was previously returned by PhotoToaster. This is the initial set of settings to apply to the image. Since PhotoToaster isn't destructive users can always change any of the settings in PhotoToaster.

####Usage Examples

phototoaster-x-callback://x-callback-url/returnEditedClipboardImage?&x-source=YourAppScheme&x-success=YourAppCallback

This support allows other apps to launch PhotoToaster with an image and receive the edited results along with the preset used for the edits. You can see the integration in action in PhotoMotion. Just check out the 'Edit In PhotoToaster' menu item. It allows you to edit images that are all ready placed in a PhotoMotion project.

The integration is based on the x-callback-url spec. To keep the implementation of additional clients simple, we offer up an IACClient implementation to allow you to integrate in minutes. IACClient is part of InterAppCommunication. This library makes using x-callback painless. The documentation for integrating InterAppCommunication is great, and once you do, the only code you need from this repo is ECP_EditAndReturnIACClient. You can use PhotoTotaster's edit and return capability without using any of this code, you jus have to send a proper x-callback request (and have an image on the clipboard).

About

Want to deeply integrate with ECP apps? Let's get started...

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published