mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 04:19:25 +00:00
71 lines
2.6 KiB
Markdown
71 lines
2.6 KiB
Markdown
# Miscellaneous
|
|
(*miscellaneous()*)
|
|
|
|
### Available Operations
|
|
|
|
* [getPublicInterstitial](#getpublicinterstitial) - Returns the markup for the interstitial page
|
|
|
|
## getPublicInterstitial
|
|
|
|
The Clerk interstitial endpoint serves an html page that loads clerk.js in order to check the user's authentication state.
|
|
It is used by Clerk SDKs when the user's authentication state cannot be immediately determined.
|
|
|
|
### Example Usage
|
|
|
|
```java
|
|
package hello.world;
|
|
|
|
import com.clerk.backend_api.Clerk;
|
|
import com.clerk.backend_api.models.components.*;
|
|
import com.clerk.backend_api.models.operations.*;
|
|
import com.clerk.backend_api.utils.EventStream;
|
|
import java.math.BigDecimal;
|
|
import java.math.BigDecimal;
|
|
import java.math.BigInteger;
|
|
import java.time.LocalDate;
|
|
import java.time.OffsetDateTime;
|
|
import java.util.Optional;
|
|
import org.openapitools.jackson.nullable.JsonNullable;
|
|
import static java.util.Map.entry;
|
|
|
|
public class Application {
|
|
|
|
public static void main(String[] args) throws Exception {
|
|
try {
|
|
Clerk sdk = Clerk.builder()
|
|
.build();
|
|
|
|
GetPublicInterstitialResponse res = sdk.miscellaneous().getPublicInterstitial()
|
|
.frontendApi("<value>")
|
|
.publishableKey("<value>")
|
|
.call();
|
|
|
|
// handle response
|
|
} catch (com.clerk.backend_api.models.errors.SDKError e) {
|
|
// handle exception
|
|
throw e;
|
|
} catch (Exception e) {
|
|
// handle exception
|
|
throw e;
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- |
|
|
| `frontendApi` | *Optional<? extends String>* | :heavy_minus_sign: | The Frontend API key of your instance |
|
|
| `publishableKey` | *Optional<? extends String>* | :heavy_minus_sign: | The publishable key of your instance |
|
|
|
|
|
|
### Response
|
|
|
|
**[Optional<? extends com.clerk.backend_api.models.operations.GetPublicInterstitialResponse>](../../models/operations/GetPublicInterstitialResponse.md)**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| ---------------------- | ---------------------- | ---------------------- |
|
|
| models/errors/SDKError | 4xx-5xx | */* |
|