openblox
Version:
Roblox API Wrapper For Both Classic And OpenCloud APIs.
82 lines (81 loc) • 4.28 kB
TypeScript
import type { ShareLinkInfo } from "./shareLinks.types";
/**
* Gets information about a share link.
* @endpoint POST /v1/resolve-link
*
* @param shareLinkId The ID (code) of the share link.
*
* @example const { data:linkInfo } = await ClassicShareLinksApi.shareLinkInfo({ shareLinkId: "0629f8e684039c4d800a1a03623e7a6f" })
* @exampleData {"experienceInviteData":null,"friendInviteData":null,"notificationExperienceInviteData":null,"profileLinkResolutionResponseData":null,"screenshotInviteData":null,"privateServerInviteData":{"status":"Valid","ownerUserId":45348281,"universeId":6430220996,"privateServerId":1630945839,"linkCode":"67771413747491684286858666824242","placeId":18980972074},"experienceDetailsInviteData":null,"avatarItemDetailsData":null,"contentPostData":null,"experienceAffiliateData":null}
* @exampleRawBody {"experienceInviteData":null,"friendInviteData":null,"notificationExperienceInviteData":null,"profileLinkResolutionResponseData":null,"screenshotInviteData":null,"privateServerInviteData":{"status":"Valid","ownerUserId":45348281,"universeId":6430220996,"privateServerId":1630945839,"linkCode":"67771413747491684286858666824242","placeId":18980972074},"experienceDetailsInviteData":null,"avatarItemDetailsData":null,"contentPostData":null,"experienceAffiliateData":null}
*/
export declare const shareLinkInfo: import("../../apiGroup/apiGroup.types").CallApiMethod<{
shareLinkId: string;
}, {
method: import("../../../utils/utils.types").RestMethod;
path: `/${string}`;
name: string;
searchParams?: string | Record<string, any> | undefined;
headers?: Record<string, any> | undefined;
body?: string | number | Record<string, any> | undefined;
formData?: FormData | undefined;
applyFieldMask?: boolean | undefined;
pathToPoll?: ((rawData: ShareLinkInfo) => string) | undefined;
getCursorsFn?: ((rawData: {
experienceInviteData: null;
friendInviteData: null;
notificationExperienceInviteData: null;
profileLinkResolutionResponseData: null;
screenshotInviteData: null;
privateServerInviteData: {
status: "Valid";
ownerUserId: import("typeforge").Identifier;
universeId: import("typeforge").Identifier;
privateServerId: import("typeforge").Identifier;
linkCode: import("typeforge").Identifier;
placeId: import("typeforge").Identifier;
};
experienceDetailsInviteData: null;
avatarItemDetailsData: null;
contentPostData: null;
experienceAffiliateData: null;
}) => [previous: import("../../apiGroup/apiGroup.types").Cursor, next: import("../../apiGroup/apiGroup.types").Cursor]) | undefined;
"\uD83D\uDD12__PRIVATE_RAW_DATA"?: {
experienceInviteData: null;
friendInviteData: null;
notificationExperienceInviteData: null;
profileLinkResolutionResponseData: null;
screenshotInviteData: null;
privateServerInviteData: {
status: "Valid";
ownerUserId: import("typeforge").Identifier;
universeId: import("typeforge").Identifier;
privateServerId: import("typeforge").Identifier;
linkCode: import("typeforge").Identifier;
placeId: import("typeforge").Identifier;
};
experienceDetailsInviteData: null;
avatarItemDetailsData: null;
contentPostData: null;
experienceAffiliateData: null;
} | undefined;
"\uD83D\uDD12__PRIVATE_FORMATTED_DATA"?: {
experienceInviteData: null;
friendInviteData: null;
notificationExperienceInviteData: null;
profileLinkResolutionResponseData: null;
screenshotInviteData: null;
privateServerInviteData: {
status: "Valid";
ownerUserId: import("typeforge").Identifier;
universeId: import("typeforge").Identifier;
privateServerId: import("typeforge").Identifier;
linkCode: import("typeforge").Identifier;
placeId: import("typeforge").Identifier;
};
experienceDetailsInviteData: null;
avatarItemDetailsData: null;
contentPostData: null;
experienceAffiliateData: null;
} | undefined;
}, false>;