C# Class PhotoSharingApp.AppService.Shared.Repositories.DocumentDbRepository

The DocumentDB data layer class.
Inheritance: IRepository
Mostra file Open project: Microsoft/Appsample-Photosharing Class Usage Examples

Private Properties

Property Type Description
CreateDocumentDbCollection Task
CreateDocumentDbDatabase Task
CreateGetRecentPhotosForCategoriesStoredProcedure System.Threading.Tasks.Task
CreatePhotoContractsAndLoadUserData Task>
CreateTransferGoldStoredProcedure System.Threading.Tasks.Task
ExecuteGoldTransactionSproc Task
GetAllCategoryDocuments Task>
GetAllUserDocumentsFromIdList Task>
GetAnnotationDocument PhotoSharingApp.AppService.Shared.Models.DocumentDB.AnnotationDocument
GetCategoryDocument PhotoSharingApp.AppService.Shared.Models.DocumentDB.CategoryDocument
GetHighestGivingUsers Task>>
GetHighestNetWorthCategories Task>>
GetHighestNetWorthPhotos Task>>
GetHighestNetWorthUser Task>>
GetParentPhotoDocument PhotoSharingApp.AppService.Shared.Models.DocumentDB.PhotoDocument
GetPhotoDocument PhotoSharingApp.AppService.Shared.Models.DocumentDB.PhotoDocument
GetUserDocumentByRegistrationReference PhotoSharingApp.AppService.Shared.Models.DocumentDB.UserDocument
GetUserDocumentByUserId PhotoSharingApp.AppService.Shared.Models.DocumentDB.UserDocument
InitializeStoredProceduresIfNotExisting System.Threading.Tasks.Task
ReplacePhotoDocument Task
ReplaceUserDocument Task
UpdateAnnotationDocument System.Threading.Tasks.Task

Public Methods

Method Description
CheckIfDatabaseAndCollectionExist ( ) : bool

Checks if database and collection exist.
CreateCategory ( string name ) : Task

Creates a new category with the provided name.
CreateUser ( string registrationReference ) : Task

Inserts a new user record in the database.
DeleteAnnotation ( string annotationId, string userRegistrationReference ) : System.Threading.Tasks.Task

Deletes an annotation.
DeletePhoto ( string photoId, string userRegistrationReference ) : System.Threading.Tasks.Task

Deletes all the data for the provided photo id.
Dispose ( ) : void

Initiates the process of releasing resources.
DocumentDbRepository ( EnvironmentDefinitionBase environmentDefinition ) : System

The DocumentDbRepository constructor.
GetCategories ( ) : Task>

Fetches all the categories and sorts them by name.
GetCategoriesPreview ( int numberOfThumbnails ) : Task>

Retrieves all the categories that have atleast one photo and also retrieves number of provided thumbnails for the photos in each category.
GetCategoryPhotoStream ( string categoryId, string continuationToken = null ) : Task>

Fetches the photo stream data for a provided category.
GetHeroPhotos ( int count, int daysOld ) : Task>

Gets hero photos.
GetLeaderboard ( int mostGoldCategoriesCount, int mostGoldPhotosCount, int mostGoldUsersCount, int mostGivingUsersCount ) : Task

Gets the leaderboard data.
GetPhoto ( string id ) : Task

Gets the photo data for provided photo id.
GetPhotosWithStatus ( PhotoStatus status ) : Task>

Gets the list of photos with a specific status.
GetUser ( string userId, string registrationReference = null ) : Task

Gets the user by an existing app user id OR registrationReference from Azure Mobile Services auth mechanism as the userId may not be known at time of entry.
GetUserPhotoStream ( string userId, string continuationToken, bool includeNonActivePhotos = false ) : Task>

Fetches the photo stream data for a specified user.
InitializeDatabaseIfNotExisting ( string serverPath ) : System.Threading.Tasks.Task

Checks if the defined document database and collection exists and initializes them if they don't.
InsertAnnotation ( AnnotationContract annotationContract ) : Task

Inserts the annotation object and performs the required gold transactions.
InsertIapPurchase ( IapPurchaseContract validatedIapReciept ) : Task

Inserts receipt and adds gold to user.
InsertPhoto ( PhotoContract photo, int goldIncrement ) : Task

Insert the photo object into storage.
InsertReport ( ReportContract reportContract, string userRegistrationReference ) : Task

Inserts a report into Report table.
ReinitializeDatabase ( string serverPath ) : System.Threading.Tasks.Task

Forces a reinitalization of the database by recreating the document database and collection.
UpdatePhoto ( PhotoContract photoContract ) : Task

Updates an existing photo object's category and description fields.
UpdatePhotoStatus ( PhotoContract photoContract ) : Task

Updates the status of the stored photo object.
UpdateUser ( UserContract userContract ) : Task

Updates the user profile picture. User gold balance is also updated if it is the first time the user is updating their profile picture.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Releases resources.

Private Methods

Method Description
CreateDocumentDbCollection ( Microsoft.Azure.Documents.Database database ) : Task
CreateDocumentDbDatabase ( ) : Task
CreateGetRecentPhotosForCategoriesStoredProcedure ( string serverPath ) : System.Threading.Tasks.Task
CreatePhotoContractsAndLoadUserData ( IList photoDocuments ) : Task>

Processes a list of photo json documents and creates PhotoContract for them, as well as fetching and setting the proper UserContract objects for PhotoContract.User and AnnotationContract.From fields.
CreateTransferGoldStoredProcedure ( string serverPath ) : System.Threading.Tasks.Task
ExecuteGoldTransactionSproc ( string toUserId, string fromUserId, int goldValue, GoldTransactionType transactionType, string photoId = null ) : Task
GetAllCategoryDocuments ( ) : Task>
GetAllUserDocumentsFromIdList ( ICollection listOfUserIds ) : Task>
GetAnnotationDocument ( string annotationId ) : AnnotationDocument
GetCategoryDocument ( string categoryId ) : CategoryDocument
GetHighestGivingUsers ( int count ) : Task>>
GetHighestNetWorthCategories ( int count ) : Task>>
GetHighestNetWorthPhotos ( int count ) : Task>>
GetHighestNetWorthUser ( int count ) : Task>>
GetParentPhotoDocument ( string annotationId ) : PhotoDocument
GetPhotoDocument ( string id ) : PhotoDocument
GetUserDocumentByRegistrationReference ( string registrationReference ) : UserDocument
GetUserDocumentByUserId ( string userId ) : UserDocument
InitializeStoredProceduresIfNotExisting ( string serverPath ) : System.Threading.Tasks.Task
ReplacePhotoDocument ( PhotoDocument photoDocument ) : Task
ReplaceUserDocument ( UserDocument userDocument ) : Task
UpdateAnnotationDocument ( AnnotationDocument annotationDocument ) : System.Threading.Tasks.Task

Method Details

CheckIfDatabaseAndCollectionExist() public method

Checks if database and collection exist.
public CheckIfDatabaseAndCollectionExist ( ) : bool
return bool

CreateCategory() public method

Creates a new category with the provided name.
public CreateCategory ( string name ) : Task
name string The category name to be created.
return Task

CreateUser() public method

Inserts a new user record in the database.
public CreateUser ( string registrationReference ) : Task
registrationReference string The Azure Mobile Service user id.
return Task

DeleteAnnotation() public method

Deletes an annotation.
public DeleteAnnotation ( string annotationId, string userRegistrationReference ) : System.Threading.Tasks.Task
annotationId string Id of annotation to be deleted.
userRegistrationReference string userRegistrationReference of annotation to be deleted.
return System.Threading.Tasks.Task

DeletePhoto() public method

Deletes all the data for the provided photo id.
public DeletePhoto ( string photoId, string userRegistrationReference ) : System.Threading.Tasks.Task
photoId string Id of the photo to be deleted.
userRegistrationReference string Azure Mobile Service user id.
return System.Threading.Tasks.Task

Dispose() public method

Initiates the process of releasing resources.
public Dispose ( ) : void
return void

Dispose() protected method

Releases resources.
protected Dispose ( bool disposing ) : void
disposing bool If we need to release resources or not.
return void

DocumentDbRepository() public method

The DocumentDbRepository constructor.
public DocumentDbRepository ( EnvironmentDefinitionBase environmentDefinition ) : System
environmentDefinition PhotoSharingApp.AppService.Shared.Context.EnvironmentDefinitionBase The specified environment definition.
return System

GetCategories() public method

Fetches all the categories and sorts them by name.
public GetCategories ( ) : Task>
return Task>

GetCategoriesPreview() public method

Retrieves all the categories that have atleast one photo and also retrieves number of provided thumbnails for the photos in each category.
public GetCategoriesPreview ( int numberOfThumbnails ) : Task>
numberOfThumbnails int Max number of thumbnails per category.
return Task>

GetCategoryPhotoStream() public method

Fetches the photo stream data for a provided category.
public GetCategoryPhotoStream ( string categoryId, string continuationToken = null ) : Task>
categoryId string The category id.
continuationToken string Continuation token from previous .
return Task>

GetHeroPhotos() public method

Gets hero photos.
public GetHeroPhotos ( int count, int daysOld ) : Task>
count int The number of hero photos.
daysOld int The number of days old the photos can be.
return Task>

GetLeaderboard() public method

Gets the leaderboard data.
public GetLeaderboard ( int mostGoldCategoriesCount, int mostGoldPhotosCount, int mostGoldUsersCount, int mostGivingUsersCount ) : Task
mostGoldCategoriesCount int Count of categories.
mostGoldPhotosCount int Count of photos.
mostGoldUsersCount int Count of wealthiest users.
mostGivingUsersCount int Count of most giving users.
return Task

GetPhoto() public method

Gets the photo data for provided photo id.
public GetPhoto ( string id ) : Task
id string The photo id.
return Task

GetPhotosWithStatus() public method

Gets the list of photos with a specific status.
public GetPhotosWithStatus ( PhotoStatus status ) : Task>
status PhotoStatus The photo status.
return Task>

GetUser() public method

Gets the user by an existing app user id OR registrationReference from Azure Mobile Services auth mechanism as the userId may not be known at time of entry.
public GetUser ( string userId, string registrationReference = null ) : Task
userId string The app user id.
registrationReference string [Optional] The Azure App Service user id. Default value is null.
return Task

GetUserPhotoStream() public method

Fetches the photo stream data for a specified user.
public GetUserPhotoStream ( string userId, string continuationToken, bool includeNonActivePhotos = false ) : Task>
userId string The user id.
continuationToken string Last captured ticks in the form of a string.
includeNonActivePhotos bool By default, false. If true, non-active photos are included.
return Task>

InitializeDatabaseIfNotExisting() public method

Checks if the defined document database and collection exists and initializes them if they don't.
public InitializeDatabaseIfNotExisting ( string serverPath ) : System.Threading.Tasks.Task
serverPath string
return System.Threading.Tasks.Task

InsertAnnotation() public method

Inserts the annotation object and performs the required gold transactions.
public InsertAnnotation ( AnnotationContract annotationContract ) : Task
annotationContract PhotoSharingApp.Portable.DataContracts.AnnotationContract Annotation to be inserted.
return Task

InsertIapPurchase() public method

Inserts receipt and adds gold to user.
public InsertIapPurchase ( IapPurchaseContract validatedIapReciept ) : Task
validatedIapReciept PhotoSharingApp.Portable.DataContracts.IapPurchaseContract Validated receipt values.
return Task

InsertPhoto() public method

Insert the photo object into storage.
public InsertPhoto ( PhotoContract photo, int goldIncrement ) : Task
photo PhotoSharingApp.Portable.DataContracts.PhotoContract Photo Object.
goldIncrement int Gold to award for new photo.
return Task

InsertReport() public method

Inserts a report into Report table.
public InsertReport ( ReportContract reportContract, string userRegistrationReference ) : Task
reportContract PhotoSharingApp.Portable.DataContracts.ReportContract The report being inserted.
userRegistrationReference string Azure Mobile Service user id who is reporting it.
return Task

ReinitializeDatabase() public method

Forces a reinitalization of the database by recreating the document database and collection.
public ReinitializeDatabase ( string serverPath ) : System.Threading.Tasks.Task
serverPath string
return System.Threading.Tasks.Task

UpdatePhoto() public method

Updates an existing photo object's category and description fields.
public UpdatePhoto ( PhotoContract photoContract ) : Task
photoContract PhotoSharingApp.Portable.DataContracts.PhotoContract Photo object.
return Task

UpdatePhotoStatus() public method

Updates the status of the stored photo object.
public UpdatePhotoStatus ( PhotoContract photoContract ) : Task
photoContract PhotoSharingApp.Portable.DataContracts.PhotoContract Photo object.
return Task

UpdateUser() public method

Updates the user profile picture. User gold balance is also updated if it is the first time the user is updating their profile picture.
public UpdateUser ( UserContract userContract ) : Task
userContract PhotoSharingApp.Portable.DataContracts.UserContract /// We need the whole user object as it is assumed the client will have given the photoId and /// url. ///
return Task