Skip to content

Commit d2192b8

Browse files
committed
added comments to function
1 parent 86b68d9 commit d2192b8

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

launcher-csharp/eSignature/Controllers/DeleteRestoreEnvelope.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public IActionResult RestoreEnvelopeAction(string folderName)
9797
accessToken,
9898
basePath,
9999
accountId);
100-
Folder folder = global::ESignature.Examples.DeleteRestoreEnvelope.GetFolderIdByName(
100+
Folder folder = global::ESignature.Examples.DeleteRestoreEnvelope.GetFolderByName(
101101
availableFolders.Folders,
102102
folderName);
103103

launcher-csharp/eSignature/Examples/DeleteRestoreEnvelope.cs

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,13 @@ public static FoldersResponse MoveEnvelopeToFolder(
4343
return foldersApi.MoveEnvelopes(accountId, folderId, foldersRequest);
4444
}
4545

46+
/// <summary>
47+
/// Gets the list of folders
48+
/// </summary>
49+
/// <param name="accessToken">Access Token for API call (OAuth)</param>
50+
/// <param name="basePath">BasePath for API calls (URI)</param>
51+
/// <param name="accountId">The DocuSign Account ID (GUID or short version) for which the APIs call would be made</param>
52+
/// <returns>The folders response</returns>
4653
public static FoldersResponse GetFolders(
4754
string accessToken,
4855
string basePath,
@@ -55,7 +62,13 @@ public static FoldersResponse GetFolders(
5562
return foldersApi.List(accountId);
5663
}
5764

58-
public static Folder GetFolderIdByName(List<Folder> folders, string targetName)
65+
/// <summary>
66+
/// Gets folder by name
67+
/// </summary>
68+
/// <param name="folders">List of folders to search</param>
69+
/// <param name="targetName">Name of the folder to find</param>
70+
/// <returns>The folder</returns>
71+
public static Folder GetFolderByName(List<Folder> folders, string targetName)
5972
{
6073
foreach (Folder folder in folders)
6174
{

0 commit comments

Comments
 (0)