Skip to content

Migration Guide v4.0

ATimmeh33 edited this page May 1, 2024 · 3 revisions

This is a prerelease, intended for internal use only, we suggest not migrating to v4.0

Migration Guide v4.0

The following steps need to be performed to update an existing v3.* implementation to v4.0:

Omit APIKey/UserToken

The APIKey and UserToken properties of SignHostApiClientSettings have been removed. Ensure you no longer reference these properties. You will need to use the new constructor, which only accepts an APPKey:

var settings = new SignHostApiClientSettings(
	"AppName appkey"));

Handle nullability DaysToRemind property

The type of the DaysToRemind (located in the Signer object) has been changed to be nullable int (int?). Ensure your code can handle this type change. If you want to make use of your organization's default setting, set DaysToRemind to null instead of 0:

new Signer {
	Email              = "john.doe@example.com",
	SignRequestMessage = "Could you please sign this document?",
	SendSignRequest    = true,
	DaysToRemind       = null
}

Or don't set it all:

new Signer {
	Email              = "john.doe@example.com",
	SignRequestMessage = "Could you please sign this document?",
	SendSignRequest    = true,
}