Skip to content

Commit 7fd3e1d

Browse files
authored
Update docs (#69)
* doc: Legge inn bilder og små justering på forklaring * doc: Oppdatere @examle taggene
1 parent 95a8a1c commit 7fd3e1d

File tree

4 files changed

+18
-5
lines changed

4 files changed

+18
-5
lines changed
35.3 KB
Loading

src/frameworks/feature-toggle/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Datamodellen ligger i pakken [platform-data-model](src/platform-data-model/READM
77
| | |
88
| ---- | --- |
99
| Apex ||
10-
| LWC | |
10+
| LWC | |
1111
| Flow ||
1212

1313
## Hvordan ta i bruk
@@ -17,16 +17,18 @@ Denne kan brukes på to nivåer, individuell eller generell.
1717

1818
Feature toggle customMetadata innslag og customPermissions legges i de pakkene hvor de brukes.
1919

20+
![Bilde viser opprettelse av et nytt feature flag](../../../resources/img/feature-toggle_new_myFeatureFlag.png "Nytt Feature Flag")
21+
2022
**Generell:**
21-
Det man ønsker å enkelt kunne skru en feature på eller av. Opprett en custom metadata feature toggle og aktiver/deaktiver den ved å benytte `Is_Enabled__c` flagget.
23+
Det man ønsker å enkelt kunne skru en feature på eller av. Opprett en custom metadata feature toggle og aktiver/deaktiver den ved å benytte Is Enabled (`Is_Enabled__c`) flagget.
2224
I koden sjekker man på `isFeatureEnabled(<developername til gitt feature>)`. Dette vil da gjelde for all logikk som kjører koden.
2325

24-
**Individuell:**
26+
**Individuell/gruppe:**
2527
Her kan man velge å bruke enten `customPermission` eller en kombinasjon av `Feature_Flag__mdt` og `customPermission`.
2628

2729
Ved bruk av bare `customPermission` oppretter man en custom permission og legger den til et Permission Set som tildeles den eller de som trenger tilgangen.
2830

29-
Ved bruk av en kombinasjon så opprettes det et custom permission som tildeles via Permission Set slik som over. I tillegg opprettes det et `Feature_Flag__mdt` record hvor customPermission api navnet legges til i `Required_Custom_Permission__c`. `Is_Enabled__c` flagget benyttes som vanlig til å toggle featuren av og på.
31+
Ved bruk av en kombinasjon så opprettes det et custom permission som tildeles via Permission Set slik som over. I tillegg opprettes det et `Feature_Flag__mdt` record hvor customPermission api navnet legges til i Required Custo Permission (`Required_Custom_Permission__c`). Is Enabled (`Is_Enabled__c`) flagget benyttes som vanlig til å toggle featuren av og på.
3032

3133
**Eksempel på direkte bruk:**
3234

@@ -82,6 +84,7 @@ public with sharing MyClass extends FeatureToggleBase {
8284

8385
- [platform-datamodel](src/platform-data-model/feature-flag-custom-metadata) - datamodell
8486
- [custom-metadata-dao](src/platform-utility/custom-metadata-dao) - Abstraksjon av custom metadata
87+
- [custom-permission-helper](src/platform-utility/custom-permission-helper) - Hjelpe klasse for å kunne mocke og validere custom permissions
8588

8689
```mermaid
8790
---

src/platform-utility/custom-permission-helper/main/classes/CustomPermissionHelper.cls

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
* @since 0.1.0, March 2025
1111
* @group Custom Permission Helper
1212
* @example
13-
* Eksempel på bruk:
1413
* ```
1514
* Set<String> myCustomPermissionsSet = new CustomPermissionHelper().setCustomPermissionMaps().getAssignedCustomPermissions();
1615
* ```

src/platform-utility/custom-permission-helper/main/classes/CustomPermissionHelperStub.cls

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@
55
* CustomPermissionHelper class for testing
66
* @author Tor Håkon Sigurdsen
77
* @since 0.1.0, March 2025
8+
* @group Custom Permission Helper
9+
* @example
10+
* ```
11+
* CustomPermissionHelperStub stub = new CustomPermissionHelperStub();
12+
* stub.addHasCustomPermission(true);
13+
* stub.addValidateCustomPermissionResult(true);
14+
* CustomPermissionHelper mock = stub.getMock();
15+
* CustomPermissionHelper cph = new CustomPermissionHelper();
16+
* cph.hasCustomPermission('MyCustomPermission');
17+
* cph.validateCustomPermission('MyCustomPermission');
18+
* ```
819
*/
920
@IsTest
1021
public with sharing class CustomPermissionHelperStub implements System.StubProvider {

0 commit comments

Comments
 (0)