docs

Home

All functions

Legacy functions

Categories

vuOAuthRefresh()

vuOAuthRefresh(*CSTRING Provider,*CSTRING AccountKey,*CSTRING OutText,LONG OutTextLen),SIGNED,PROC,PASCAL,RAW,NAME('vuOAuthRefresh')

Purpose

Refreshes OAuth access token state for the specified provider/account pair.

Parameters

| Parameter | Type | Description | |—|—|—| | Provider | *CSTRING | Provider identifier. | | AccountKey | *CSTRING | Account key identifier. | | OutText | *CSTRING | Output buffer receiving refresh status text. | | OutTextLen | LONG | Size of OutText buffer in bytes. |

Return value / error codes

• >= 0: Result code from core OAuth refresh operation.
• -9: Core unavailable or exception.

Example (Clarion)

MAP
  MODULE('vuMail.dll')
    vuOAuthRefresh(*CSTRING Provider,*CSTRING AccountKey,*CSTRING OutText,LONG OutTextLen),SIGNED,PROC,PASCAL,RAW,NAME('vuOAuthRefresh')
  END
END

rc         LONG
provider   CSTRING(64)
accountKey CSTRING(128)
outText    CSTRING(1024)
outLen     LONG

provider   = 'Microsoft'
accountKey = 'user@example.com'
outText    = ''
outLen     = SIZE(outText)

rc = vuOAuthRefresh(provider, accountKey, outText, outLen)
IF rc < 0
  MESSAGE('Refresh failed: ' & rc & '| ' & outText)
END

Notes

• Refresh semantics depend on provider token policy and stored refresh token availability.

Home

All functions

Legacy functions

Categories