Merge pull request xmedius#1 from lpperras/master

Async suffix on methods and .gitignore for VS.

Author: nicholasmongeau

.gitignore

@@ -0,0 +1,275 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+*.vcxproj.filters
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+bld/
+[Bb]in/
+[Oo]bj/
+[Ll]og/
+
+# Visual Studio 2015 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUNIT
+*.VisualState.xml
+TestResult.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+**/Properties/launchSettings.json
+
+*_i.c
+*_p.c
+*_i.h
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# JustCode is a .NET coding add-in
+.JustCode
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# TODO: Comment the next line if you want to checkin your web deploy settings
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# The packages folder can be ignored because of Package Restore
+**/packages/*
+# except build/, which is used as an MSBuild target.
+!**/packages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/packages/repositories.config
+# NuGet v3's project.json files produces more ignoreable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+node_modules/
+orleans.codegen.cs
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+
+# SQL Server files
+*.mdf
+*.ldf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# JetBrains Rider
+.idea/
+*.sln.iml
+
+# CodeRush
+.cr/
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/

README.md

@@ -65,7 +65,7 @@ namespace SendSecureClient
         {
             try
             {
-                string token = GetUserToken().Result;
+                string token = GetUserTokenAsync().GetAwaiter().GetResult();
             }
             catch (XMedius.SendSecure.Exceptions.SendSecureException e)
             {
@@ -77,9 +77,9 @@ namespace SendSecureClient
             }
         }
 
-        public static async Task<string> GetUserToken()
+        public static async Task<string> GetUserTokenAsync()
         {
-            string token = await XMedius.SendSecure.Client.GetUserToken("deathstar", "darthvader", "d@Rk$1De", "DV-TIE/x1", "TIE Advanced x1", "The Force App", new Uri("https://portal.xmedius.com"));
+            string token = await XMedius.SendSecure.Client.GetUserTokenAsync("deathstar", "darthvader", "d@Rk$1De", "DV-TIE/x1", "TIE Advanced x1", "The Force App", new Uri("https://portal.xmedius.com"));
 
             Console.WriteLine(token);
             return token;
@@ -112,7 +112,7 @@ namespace SendSecureClient
             {
                 string token = "USER|1d495165-4953-4457-8b5b-4fcf801e621a";
 
-                string previewUrl = SubmitSafebox(token).GetAwaiter().GetResult();
+                string previewUrl = SubmitSafeboxAsync(token).GetAwaiter().GetResult();
             }
             catch (XMedius.SendSecure.Exceptions.SendSecureException e)
             {
@@ -124,7 +124,7 @@ namespace SendSecureClient
             }
         }
 
-        public static async Task<string> SubmitSafebox(string token)
+        public static async Task<string> SubmitSafeboxAsync(string token)
         {
             var safebox2 = new XMedius.SendSecure.Helpers.Safebox("[email protected]");
             safebox2.Subject = "Family matters";
@@ -138,7 +138,7 @@ namespace SendSecureClient
             safebox2.Recipients.Add(recipient);
 
             XMedius.SendSecure.Client client = new Client(token, "deathstar", new Uri("https://portal.xmedius.com"));
-            XMedius.SendSecure.Helpers.SafeboxResponse safeboxResponse = await client.SubmitSafebox(safebox2);
+            XMedius.SendSecure.Helpers.SafeboxResponse safeboxResponse = await client.SubmitSafeboxAsync(safebox2);
 
             Console.WriteLine(safeboxResponse.PreviewUrl);
             return safeboxResponse.PreviewUrl;
@@ -154,7 +154,7 @@ namespace SendSecureClient
 
 ### Get User Token
 ```
-GetUserToken(enterpriseAccount, username, password, deviceId, deviceName, applicationType, endpoint, oneTimePassword, cancellationToken)
+GetUserTokenAsync(enterpriseAccount, username, password, deviceId, deviceName, applicationType, endpoint, oneTimePassword, cancellationToken)
 ```
 Creates and returns an API Token for a specific user within a SendSecure enterprise account.
 Calling this method again with the exact same params will always return the same Token.
@@ -185,7 +185,7 @@ locale            | String | The locale in which the server errors will be retur
 
 ### Get Enterprise Settings
 ```
-EnterpriseSettings(cancellationToken)
+EnterpriseSettingsAsync(cancellationToken)
 ```
 Returns all values/properties of the enterprise account's settings specific to SendSecure.
 
@@ -195,7 +195,7 @@ cancellationToken | CancellationToken | A cancellation token that can be used by
 
 ### Get Default Security Profile
 ```
-DefaultSecurityProfile(userEmail, cancellationToken)
+DefaultSecurityProfileAsync(userEmail, cancellationToken)
 ```
 Returns the default security profile (if it has been set) for a specific user, with all its setting values/properties.
 
@@ -206,7 +206,7 @@ cancellationToken | CancellationToken | A cancellation token that can be used by
 
 ### Get Security Profiles
 ```
-SecurityProfiles(userEmail, cancellationToken)
+SecurityProfilesAsync(userEmail, cancellationToken)
 ```
 Returns the list of all security profiles available to a specific user, with all their setting values/properties.
 
@@ -217,7 +217,7 @@ cancellationToken | CancellationToken | A cancellation token that can be used by
 
 ### Initialize SafeBox
 ```
-InitializeSafebox(safebox, cancellationToken)
+InitializeSafeboxAsync(safebox, cancellationToken)
 ```
 Pre-creates a SafeBox on the SendSecure system and returns the updated Safebox object with the necessary system parameters filled out (GUID, public encryption key, upload URL).
 
@@ -228,7 +228,7 @@ cancellationToken | CancellationToken | A cancellation token that can be used by
 
 ### Upload Attachment
 ```
-UploadAttachment(safebox, attachment, cancellationToken)
+UploadAttachmentAsync(safebox, attachment, cancellationToken)
 ```
 Uploads the specified file as an Attachment of the specified SafeBox and returns the updated Attachment object with the GUID parameter filled out.
 
@@ -240,7 +240,7 @@ cancellationToken | CancellationToken | A cancellation token that can be used by
 
 ### Commit SafeBox
 ```
-CommitSafebox(safebox, cancellationToken)
+CommitSafeboxAsync(safebox, cancellationToken)
 ```
 Finalizes the creation (commit) of the SafeBox on the SendSecure system.
 This actually "Sends" the SafeBox with all content and contact info previously specified.
@@ -252,7 +252,7 @@ cancellationToken | CancellationToken | A cancellation token that can be used by
 
 ### Submit SafeBox
 ```
-SubmitSafebox(safebox, cancellationToken)
+SubmitSafeboxAsync(safebox, cancellationToken)
 ```
 This method is a high-level combo that initializes the SafeBox, uploads all attachments and commits the SafeBox.