Skip to content

Commit 039edd3

Browse files
docs: add documentation to passport methods (#143)
1 parent 80c77bf commit 039edd3

File tree

2 files changed

+292
-13
lines changed

2 files changed

+292
-13
lines changed

Source/Immutable/Public/Immutable/ImmutableDataTypes.h

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,29 +38,47 @@ struct FImmutableEngineVersionData
3838
FString deviceModel = FGenericPlatformMisc::GetDeviceMakeAndModel();
3939
};
4040

41+
/**
42+
* Structure to hold initialisation data for the Immutable Passport.
43+
*/
4144
USTRUCT()
4245
struct IMMUTABLE_API FImmutablePassportInitData
4346
{
4447
GENERATED_BODY()
4548

49+
/** The Client Id. */
4650
UPROPERTY()
4751
FString clientId;
4852

53+
/**
54+
* (Android, iOS, and macOS only)
55+
* The URL where the browser will redirect after successful authentication.
56+
*/
4957
UPROPERTY()
5058
FString redirectUri;
5159

60+
/** The URL where the browser will redirect after logout is complete. */
5261
UPROPERTY()
5362
FString logoutRedirectUri;
5463

64+
/** The environment to connect to. */
5565
UPROPERTY()
5666
FString environment = ImmutablePassportAction::EnvSandbox;
5767

68+
/** Whether silent logout is enabled. */
5869
UPROPERTY()
5970
bool isSilentLogout = false;
6071

72+
/** Information about engine version */
6173
UPROPERTY()
6274
FImmutableEngineVersionData engineVersion;
6375

76+
/**
77+
* Converts the FImmutablePassportInitData structure to a JSON string representation.
78+
*
79+
* @return A JSON string representation of the FImmutablePassportInitData structure.
80+
* Returns an empty string if the conversion fails.
81+
*/
6482
FString ToJsonString() const;
6583
};
6684

@@ -158,12 +176,15 @@ struct IMMUTABLE_API FImmutablePassportResult
158176
{
159177
GENERATED_BODY()
160178

179+
/** Whether the response was successful. */
161180
UPROPERTY()
162181
bool Success = false;
163-
182+
183+
/** Error string for the response. */
164184
UPROPERTY()
165185
FString Error;
166186

187+
/** Response payload. */
167188
FImtblJSResponse Response;
168189
};
169190

0 commit comments

Comments
 (0)