Skip to content

Commit

Permalink
docs: update to include redirectUri parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
amandah committed Mar 4, 2022
1 parent ab01eeb commit cd03f1a
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 20 deletions.
4 changes: 3 additions & 1 deletion docs/api_ref.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ CCEverywhere.default.initialize(
clientId: YOUR_CLIENT_ID,
appName: YOUR_PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web'
platformCategory: 'web',
redirectUri: YOUR_REDIRECT_URI
},
/* ConfigParams (optional) */
{
Expand All @@ -55,6 +56,7 @@ All properties are required. **appName** defines the name of a folder created fo
|appName | string | Name of CCX project folder created for user
|appVersion | { major: number, minor: number, patch?: number} | Your app version
| platformCategory | 'web' | Specify host app platform
| redirectUri | string | Searches for redirect URL you define in [console](https://developer.adobe.com/console)


## ConfigParams
Expand Down
3 changes: 2 additions & 1 deletion docs/create_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,8 @@ When the "createDesign" button is clicked, the Create Project API is called and
clientId: YOUR_CLIENT_ID,
appName: PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web'
platformCategory: 'web',
redirectUri: YOUR_REDIRECT_URI
}
);
Expand Down
3 changes: 2 additions & 1 deletion docs/edit_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ When the "editButton" button is clicked, the Open Project API is passed the curr
clientId: YOUR_CLIENT_ID
appName: PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web'
platformCategory: 'web',
redirectUri: YOUR_REDIRECT_URI
}
);
Expand Down
6 changes: 4 additions & 2 deletions docs/quick_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,8 @@ They can then click the "Image Crop" button, which call the Quick Actions API. A
clientId: YOUR_CLIENT_ID,
appName: PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web'
platformCategory: 'web',
redirectUri: YOUR_REDIRECT_URI
}
);
Expand Down Expand Up @@ -232,7 +233,8 @@ They can then click the "Change Speed" button, which call the Quick Actions API.
clientId: YOUR_CLIENT_ID,
appName: PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web'
platformCategory: 'web',
redirectUri: YOUR_REDIRECT_URI
}
);
Expand Down
15 changes: 7 additions & 8 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,13 @@ embedSDK(document, "./CCEverywhere.js");
To initialize the SDK, call the default method `initialize()`:

```js
const ccEverywhere = CCEverywhere.default.initialize(
{
clientId: <CLIENT_ID>,
appName: <APP_NAME>,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web'
}
);
const ccEverywhere = CCEverywhere.default.initialize({
clientId: <CLIENT_ID>,
appName: <APP_NAME>,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web',
redirectUri: YOUR_REDIRECT_URI
});
```

This method returns a `CCEverywhere` object, with two methods:
Expand Down
7 changes: 4 additions & 3 deletions sample/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,16 @@
var image_data = document.getElementById("savedDesign");

ccEverywhere = CCEverywhere.default.initialize({
clientId: '695a1c27f4e147b28d4df7a7a8c46d23',
// stage clientId: '8a485e7470094408a3510b262f404f3d',
clientId: 'c352fd34caa94405ab1a2cfa736bb9f5',
appName: PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web',
redirectUri: 'https://localhost:8000/redirect.html'
redirectUri: 'https://localhost:3000/redirect.html'
});

document.getElementById("QA").addEventListener('click', () => {
window.location.href = "https://localhost:8000/quickactions.html";
window.location.href = "https://localhost:3000/quickactions.html";
});


Expand Down
4 changes: 2 additions & 2 deletions sample/quickactions.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,11 +110,11 @@ <h1> Video Quick Actions </h1>
// var appVideo = document.getElementById('video-container');

const ccEverywhere = CCEverywhere.default.initialize({
clientId: '695a1c27f4e147b28d4df7a7a8c46d23',
clientId: 'c352fd34caa94405ab1a2cfa736bb9f5',
appName: PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web',
redirectUri: 'https://localhost:8000/redirect.html'
redirectUri: 'https://localhost:3000/redirect.html'
});

/* This event listener checks to see if the user uploads a new file
Expand Down
4 changes: 2 additions & 2 deletions sample/redirect.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
const PROJECT_NAME = 'cc everywhere';

ccEverywhere = CCEverywhere.default.initialize({
clientId: '695a1c27f4e147b28d4df7a7a8c46d23',
clientId: 'c352fd34caa94405ab1a2cfa736bb9f5',
appName: PROJECT_NAME,
appVersion: { major: 1, minor: 0 },
platformCategory: 'web',
redirectUri: 'https://localhost:8000/redirect.html'
redirectUri: 'https://localhost:3000/redirect.html'
});

ccEverywhere.exchangeAuthCodeForToken();
Expand Down

0 comments on commit cd03f1a

Please sign in to comment.