Skip to content

Commit

Permalink
Merge pull request #178 from decentralised-dataexchange/feature/177-U…
Browse files Browse the repository at this point in the history 
…pdate-read-me-file-with-new-SDK-methods
  • Loading branch information
@georgepadayatti
georgepadayatti authored Nov 16, 2023
2 parents 844d9cd + 3e5d847 commit e0bac62
Showing 1 changed file with 162 additions and 40 deletions.
202 changes: 162 additions & 40 deletions PrivacyDashboardiOS/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,57 +5,179 @@
[![License](https://img.shields.io/cocoapods/l/PrivacyDashboardiOS.svg?style=flat)](https://cocoapods.org/pods/PrivacyDashboardiOS)
[![Platform](https://img.shields.io/cocoapods/p/PrivacyDashboardiOS.svg?style=flat)](https://cocoapods.org/pods/PrivacyDashboardiOS)

## Example

To run the example project, clone the repo, and run `pod install` from the Example directory first.

## Requirements

Environment iOS 13.0+

## Installation

PrivacyDashboardiOS is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
## 1. iOS Configuration
[PrivacyDashboardiOS](https://cocoapods.org/pods/PrivacyDashboardiOS#about) is available through [CocoaPods](https://cocoapods.org). To install it, simply add the following line to your Podfile after all [pod set up](https://guides.cocoapods.org/using/getting-started.html) done:

```ruby
pod 'PrivacyDashboardiOS'
pod 'PrivacyDashboardiOS','2023.11.10'
```
## 2. iOS Integration

## Usage

You can easily present the PrivacyDashboardHomeVC by the code shown below:
Paste the below code in ViewDidAppear method.

```swift
Import PrivacyDashboard SDK
```
#import PrivacyDashboardiOS
BBConsentPrivacyDashboardiOS.shared.show(organisationId: <Org ID>, apiKey: <API key>, userId: <User ID>)
```

To enable User requests, add the following line:

```swift
BBConsentPrivacyDashboardiOS.shared.turnOnUserRequests = true
We can initiate the privacy dashboard by calling:
```

To enable Ask me section in attribute detail screen, add the following line:

```swift
BBConsentPrivacyDashboardiOS.shared.turnOnAskMeSection = true
PrivacyDashboard.showPrivacyDashboard(withApiKey: <apiKey>,
withUserId: <userId>,
withOrgId: <orgId>,
withBaseUrl: <baseUrl>,
turnOnAskme: <Bool>,
turnOnUserRequest: <Bool>,
turnOnAttributeDetail: <Bool>)
```
We can also show the privacy dashboard with `accessToken` (optional parameter).
> **_Note:_** If we have `accessToken` then no need to pass `API key` and `User ID`
To disable PRivacyDashBoardiOS presenting animation, invoke SDK as shown:

```swift
#import PrivacyDashboardiOS
BBConsentPrivacyDashboardiOS.shared.show(organisationId: <Org ID>, apiKey: <API key>, userId: <User ID>, animate: false)
To enable user requests, set the `turnOnUserRequest` to `true`
```
By default it will be turned on.

## Author
.turnOnUserRequest : true
```
To enable Ask me, set the `turnOnAskme` to `true`
```
.turnOnAskme : true
```
To enable Attribute detail screen, set the `turnOnAttributeDetail` to `true`
```
.turnOnAttributeDetail : true
```
#### Data Sharing UI
To initiate the Data sharing UI
```
PrivacyDashboard.showDataSharingUI(apiKey: <API key>,
userId: <API key>,
baseUrlString: <>,
dataAgreementId: <Data Agreement ID>,
organisationName: <Third party application name>,
organisationLogoImageUrl: <Third party application logo>,
termsOfServiceText:<Terms of service text>,
termsOfServiceUrl: <Terms url>,
cancelButtonText: <Cancel button text>)
```
We can also show the privacy dashboard with `accessToken` with below param
```
.accessToken(<accessToken>)
```
> **_Note:_** If we have `accessToken` then no need to pass `API key` and `User ID`
iGrant.io
In response, it will return a json string as follows. `Null` if the process failed
```
{
"id": "********************",
"dataAgreementId": "********************",
"dataAgreementRevisionId": "********************",
"dataAgreementRevisionHash": "*******************************",
"individualId": "********************",
"optIn": Boolean,
"state": "*********",
"signatureId": ""
}
```
#### Configuring API key or Access token
Below 'configure' method should be called before api calls which doesnt have API key or access token as params.
```
PrivacyDashboard.configure(withApiKey: <APIKey>,
withOrgId: <OrgId>,
withBaseUrl: <BaseUrl>,
accessToken: <accessToken>)
```
#### Opt-in to Data Agreement
This function is used to provide the 3PP developer to opt-in to a data agreement.
```
PrivacyDashboard.updateDataAgreementStatus(dataAgreementId: <Data Agreement ID>,
status: <True always>)
```

## License
In response, it will return a json string as follows. `Null` if the process failed
```
{
"id": "********************",
"dataAgreementId": "********************",
"dataAgreementRevisionId": "********************",
"dataAgreementRevisionHash": "*******************************",
"individualId": "********************",
"optIn": Boolean,
"state": "*********",
"signatureId": ""
}
```
#### Fetch Data Agreement
This function is used to fetch the data agreement using `dataAgreementId`
```
PrivacyDashboard.readDataAgreementApi(dataAgreementId: <>) {
success, resultVal in
// Result val will be a callback
// response in dictionary format
}
```
#### Show data agreement policy
To show data agreement policy, fetch the data agreement with the above API, pass the response with below api request
```
PrivacyDashboard.showDataAgreementPolicy(dataAgreementRecord:
<Data agreement response>)
```

PrivacyDashboardiOS is available under the MIT license. See the LICENSE file for more info.
#### Individual Functions
##### To Create an Individual
To create individual below one is the API request
```
PrivacyDashboard.createAnIndividual(
name: <Optional>,
email: <Optional>,
phone: <Optional>)
{ success, resultVal in
// Result val will be a callback
// response in dictionary format
}
```
##### To fetch an Individual
To fetch indivdual details
```
PrivacyDashboard.readAnIndividual(
individualId = <individual ID>
{ success, resultVal in
// Result val will be a callback
// response in dictionary format
}
```
##### To update an Individual
To update individual record
```
PrivacyDashboard.updateAnIndividual(
individualId = <individual ID>
{ success, resultVal in
// Result val will be a callback
// response in dictionary format
}
```
##### To fetch all individuals
To fetch all individual records
```
PrivacyDashboard.fetchAllIndividuals(
individualId = <individual ID>
{ success, resultVal in
// Result val will be a callback
// response in dictionary format
}
```

## Release Status

Refer to the [wiki page](https://github.com/decentralised-dataexchange/bb-consent-docs/wiki/wps-and-deliverables) for the latest status of the deliverables.

## Other resources

* Wiki - https://github.com/decentralised-dataexchange/consent-dev-docs/wiki

## Contributing

Feel free to improve the plugin and send us a pull request. If you find any problems, please create an issue in this repo.

## Licensing
Copyright (c) 2023-25 LCubed AB (iGrant.io), Sweden

Licensed under the Apache 2.0 License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.

0 comments on commit e0bac62

Please sign in to comment.