RefreshToken Property

Specifies the refresh token received from or sent to the authorization server.

Syntax

ANSI (Cross Platform)
char* GetRefreshToken();
int SetRefreshToken(const char* lpszRefreshToken); Unicode (Windows) LPWSTR GetRefreshToken();
INT SetRefreshToken(LPCWSTR lpszRefreshToken);
@property (nonatomic,readwrite,assign,getter=refreshToken,setter=setRefreshToken:) NSString* refreshToken;
- (NSString*)refreshToken;
- (void)setRefreshToken:(NSString*)newRefreshToken;
#define PID_OAUTH_REFRESHTOKEN 36

CLOUDKEYS_EXTERNAL void* CLOUDKEYS_CALL CloudKeys_OAuth_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_OAuth_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

When GetAuthorization is called if the authorization server returns a refresh token along with the access token, this property will hold the refresh token. Save this value for later use.

When your access token expires, set this property to the corresponding refresh token. Then call GetAuthorization and the class will use this token to retrieve a new access token. The new authorization string will be returned by the GetAuthorization method. No user interaction is required when refreshing an access token.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 C++ Edition - Version 20.0 [Build 8157]