IPWorks Cloud 2020 C++ Edition

Questions / Feedback?

AuthorizationCode Property

The authorization code that is exchanged for an access token.

Syntax

ANSI (Cross Platform)
char* GetAuthorizationCode();
int SetAuthorizationCode(const char* lpszAuthorizationCode); Unicode (Windows) LPWSTR GetAuthorizationCode();
INT SetAuthorizationCode(LPCWSTR lpszAuthorizationCode);
@property (nonatomic,readwrite,assign,getter=authorizationCode,setter=setAuthorizationCode:) NSString* authorizationCode;
- (NSString*)authorizationCode;
- (void)setAuthorizationCode:(NSString*)newAuthorizationCode;
#define PID_OAUTH_AUTHORIZATIONCODE 2

IPWORKSCLOUD_EXTERNAL void* IPWORKSCLOUD_CALL IPWorksCloud_OAuth_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSCLOUD_EXTERNAL int IPWORKSCLOUD_CALL IPWorksCloud_OAuth_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

When ClientProfile is set to cfWebServer (WebServer flow) the authorization server will return a code when the user is re-directed from the authorization server back to your website. This code is returned as a query string parameter and the class will automatically populate this property with that value.

Normally this property will only be informational, as the GetAuthorization method will automatically exchange this code for a token with the authorization server specified in ServerTokenURL.

If this property is set before calling GetAuthorization the class will attempt to exchange the code with the authorization server for an access token.

This property is not available at design time.

Data Type

String

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