SDK Upgrade Documentation

[TonyValenti]

Can you please post some documentation about how to upgrade to the latest version of the SDK?
Specifically, things like:

• Do we have to explicitly request fields.
• What are the equivalents to IBoxConfig, BoxConfigBuilder, and OAuthSession

[mwwoda]

Hello,

To answer your questions:

Do we have to explicitly request fields

In some cases Box API requires you to specifically send name of the fields to get additional data about entities. For example here when getting shared link for a file - https://developer.box.com/reference/get-files-id--get-shared-link/#param-fields. SDK function usually resemble API endpoints quite closely. In case you want to get shared link for a file via SDK, you also need to send the shared_link in a fields parameter, see example - https://github.com/box/box-windows-sdk-v2/blob/sdk-gen/Box.Sdk.Gen.Tests.Integration.Net/Test/SharedLinksFiles/SharedLinksFilesManagerTests.cs#L21

What are the equivalents to IBoxConfig, BoxConfigBuilder, and OAuthSession

Both IBoxConfig and BoxConfigBuilder were replaced by auth specific configuration classes like JwtConfig and CcgConfig that accepts data relevant to the given authentication. Here's the page with more information about the auth - https://github.com/box/box-windows-sdk-v2/blob/sdk-gen/docs/Authentication.md
Most of the OAuthSession information is encapsulated in AccessToken class now https://github.com/box/box-windows-sdk-v2/blob/sdk-gen/Box.Sdk.Gen.Net/Schemas/AccessToken/AccessToken.cs. Is there something particular you want to use this for?

[TonyValenti]

Yes. We'd like to upgrade our app to use the latest SDK and we're trying to figure things out since this update is so hugely different from the prior sdk.

[mwwoda]

I understand, as this version is quite different to the older version (v5) of the SDK. I recommend exploring docs or even our integration test suite to understand how to use this SDK. Feel free to ask any questions too.

We are currently working on the major version that will be between the old one (v5) and the newest one (v10) which should be labeled v6. This version will contain both of the artifacts in one .nupkg. We plan to release it in several weeks, but it is still subject to change. If you think the migration of your existing codebase is huge effort, you could wait for this version in migrate gradually.

[mwwoda]

If you have any more issues, feel free to reopen this discussion or open a new one