Class UriLinksResource

URI launch link management — create, list, revoke, and resolve deep-links that launch the StarComms client into a specific guild/net/org-link.

Example

// List existing links
const { links } = await client.uriLinks.list();

// Create a "join guild" link that expires in 7 days
const { link, token, directUri } = await client.uriLinks.create("join:guild", "Fleet Night Invite", {
  expiresDays: 7,
  maxUses: 50,
});
console.log(directUri); // starcomms://launch?shard=...&id=...&token=...

// Revoke a link
await client.uriLinks.revoke(link.id);

// Resolve a link (public, no auth required)
const resolved = await client.uriLinks.resolve(link.id, token);
console.log(resolved.action, resolved.target);

Constructors

constructor

Methods

create list resolve revoke

Constructors

constructor

Methods

create

  • create(
        action: UriLinkAction,
        name?: string,
        options?: {
            expiresAt?: string;
            expiresDays?: number;
            expiresMinutes?: number;
            maxUses?: number;
            target?: UriLinkTarget;
        },
    ): Promise<UriLinkCreateResponse>

    Create a new URI launch link. Requires write:uri scope. Creating a join:org-link action also requires write:uri:org-link.

    Parameters

    • action: UriLinkAction

      Action the link performs when resolved.

    • Optionalname: string

      Human-readable name for the link.

    • Optionaloptions: {
          expiresAt?: string;
          expiresDays?: number;
          expiresMinutes?: number;
          maxUses?: number;
          target?: UriLinkTarget;
      }

      Optional expiry, max uses, and target configuration.

    Returns Promise<UriLinkCreateResponse>

    The created link with the one-time secret token and launch URLs.

list

resolve

  • resolve(id: string, token: string): Promise<UriLinkResolveResponse>

    Resolve a URI link — returns the launch intent (action + target). This endpoint is public (no owner key required). Increments use count.

    Parameters

    • id: string

      The URI link ID.

    • token: string

      The secret token issued at creation.

    Returns Promise<UriLinkResolveResponse>

revoke

Settings

Member Visibility

On This Page

Constructors
Methods