Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Yash DevsTree authored Oct 3, 2022
1 parent e16c433 commit faf2cbf
Showing 1 changed file with 19 additions and 9 deletions.
28 changes: 19 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,24 @@ If you want to read the full API documentation of SaaS SDK, see [here].
- in "Build Phases" tab, expand "Link Binary With Libraries"
- remove UnityFramework.framework, UnityDriver.framework, VuforiaEngine.framework from the list (select it and press - )
<br><img src="images/removeLink.png">

- Use below mentioned methods to load, unload Flam Cam.\
To load the Flam Cam use the below parameters, All parameters are required unless otherwise stated.

| Option | Type | Description |
| :------------ | ----------------- | ------------------------------------------------------------------- |
| `clientKey` | string (required) | Flam SDK key recieved from `business.flamapp.com` after signin up. |
| `clientName` | string (required) | Flam SDK name recieved from `business.flamapp.com` after signin up. |
| `clientSource`| string (required) | SAAS |
- Import the ```FlamCam.h``` and ```FlamCam.m``` file located in this [Sample App] to your Native iOS Project.
- Use below mentioned methods to load Flam Cam.
```
[((FlamCam *)[[UIApplication sharedApplication] delegate]) initFlamCam:@"EnterSaaSKeyHere" clientName: @"EnterSaaSNameHere" source:@"SAAS"];
[((FlamCam *)[[UIApplication sharedApplication] delegate]) loadFlamCamView];
```
To load the Flam Cam use the below parameters, All parameters are required unless otherwise stated.
| Option | Type | Description |
| :------------ | ----------------- | ------------------------------------------------------------------- |
| `clientKey` | string (required) | Flam SDK key recieved from `business.flamapp.com` after signin up. |
| `clientName` | string (required) | Flam SDK name recieved from `business.flamapp.com` after signin up. |
| `clientSource`| string (required) | SAAS |
- Use below mentioned methods to unload Flam Cam.
```
[((FlamCam *)[[UIApplication sharedApplication] delegate]) unloadFlamCam];
```
## IssueReporting
Expand All @@ -42,5 +51,6 @@ If you have found a bug or if you have a feature request, please report them at
[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen. Thanks SO - http://stackoverflow.com/questions/4823468/store-comments-in-markdown-syntax)
[here]: <https://business.flamapp.com>
[Sample App]: <https://github.com/homingos/saaskit-cam-ios-sample/tree/main/NativeiOSApp/NativeiOSApp>
[Support Center]: <https://help.flamapp.com>
[Flam]: <https://flamapp.com>

0 comments on commit faf2cbf

Please sign in to comment.