anas/divan
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects Releases Wiki Activity
7a09d7ad1b
divan/RMuseum/RMuseum.xml
Hamid Reza Mohammadi fb1b00a3df add reviewmsg to recitation view model
2020-11-20 17:53:11 +03:30

5657 lines
226 KiB
XML
Raw Blame History

<?xml version="1.0"?>
<doc>
<assembly>
<name>RMuseum</name>
</assembly>
<members>
<member name="T:RMuseum.Controllers.AppUserController">
<summary>
User login/logout/register/...
</summary>
</member>
<member name="M:RMuseum.Controllers.AppUserController.#ctor(Microsoft.Extensions.Configuration.IConfiguration,RSecurityBackend.Services.IAppUserService,Microsoft.AspNetCore.Http.IHttpContextAccessor,RSecurityBackend.Services.IUserPermissionChecker,Microsoft.AspNetCore.Identity.UI.Services.IEmailSender,RSecurityBackend.Services.IImageFileService,RSecurityBackend.Services.ICaptchaService)">
<summary>
constructor
</summary>
<param name="configuration"></param>
<param name="appUserService"></param>
<param name="httpContextAccessor"></param>
<param name="userPermissionChecker"></param>
<param name="emailSender"></param>
<param name="imageFileService"></param>
<param name="captchaService"></param>
</member>
<member name="M:RMuseum.Controllers.AppUserController.GetSignUpEmailSubject(System.String)">
<summary>
Sign Up Email Subject
</summary>
<returns>
subject
</returns>
<param name="secretCode"></param>
</member>
<member name="M:RMuseum.Controllers.AppUserController.GetSignUpEmailHtmlContent(System.String)">
<summary>
Sign Up Email Html Content
</summary>
<param name="secretCode"></param>
<returns>html content</returns>
</member>
<member name="M:RMuseum.Controllers.AppUserController.GetForgotPasswordEmailSubject(System.String)">
<summary>
Forgot Password Email Subject
</summary>
<returns>
subject
</returns>
<param name="secretCode"></param>
</member>
<member name="M:RMuseum.Controllers.AppUserController.GetForgotPasswordEmailHtmlContent(System.String)">
<summary>
Forgot Password Email Html Content
</summary>
<param name="secretCode"></param>
<returns>html content</returns>
</member>
<member name="M:RMuseum.Controllers.AppUserController.IsSignupEnabled">
<summary>
Is Sign-up enabled?
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.Get(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
get all published artifacts (including CoverImage info but not items info)
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController._GetUserVisibleArtifactStatusSet(System.Guid,System.Guid)">
<summary>
get list of artifact statuses user can see
</summary>
<param name="loggedOnUserId"></param>
<param name="sessionId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserVisible(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
get all artifacts visible by user (including CoverImage info but not items info)
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.Get(System.String)">
<summary>
gets specified publish artifact info (including CoverImage + images)
</summary>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.RemoveArtifactHavingNoNoteAndBookmarks(System.Guid)">
<summary>
remove unpublished artifact having no notes and not bookmarked
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetByFriendlyUrlFilterItemsByTag(System.String,System.String)">
<summary>
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag
</summary>
<param name="friendlyUrl"></param>
<param name="tagFriendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetByFriendlyUrlFilterItemsByTag(System.String,System.String,System.String)">
<summary>
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag
</summary>
<param name="friendlyUrl"></param>
<param name="tagFriendlyUrl"></param>
<param name="valueFriendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserVisible(System.String)">
<summary>
gets specified publish artifact info (including CoverImage + images)
</summary>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserVisibleByFriendlyUrlFilterItemsByTag(System.String,System.String)">
<summary>
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag
</summary>
<param name="friendlyUrl"></param>
<param name="tagFriendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserVisibleByFriendlyUrlFilterItemsByTag(System.String,System.String,System.String)">
<summary>
gets specified publish artifact info (including CoverImage + images) where its items are filteted by tag
</summary>
<param name="friendlyUrl"></param>
<param name="tagFriendlyUrl"></param>
<param name="valueFriendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.Put(System.Guid,RMuseum.Models.Artifact.RArtifactMasterRecord)">
<summary>
edit artifactt master record (user should have additional permissions artifact:awaiting and artifact:publish to change status of artifact)
</summary>
<remarks>
editing related collections such as images and attributed or complex properties such as CoverImage is ignored
</remarks>
<param name="id"></param>
<param name="item"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.SetArtifactCoverItemIndex(System.Guid,System.Int32)">
<summary>
Set Artifact Cover Item Index
</summary>
<param name="id"></param>
<param name="itemIndex"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetTagBundleByFiendlyUrl(System.String)">
<summary>
get tag bundle by frindly url
</summary>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.NewTag(RMuseum.Models.Artifact.RTag)">
<summary>
add new tag
</summary>
<param name="tag">only name is processed</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetTags(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
get all tags
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.PutTag(System.Guid,RMuseum.Models.Artifact.RTag)">
<summary>
edit tag
</summary>
<remarks>
editable fields are limited
</remarks>
<param name="tagid"></param>
<param name="tag"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.MoveTag(System.Guid,System.Guid,System.String)">
<summary>
changes order of tags based on their position in artifacts
</summary>
<param name="tagId"></param>
<param name="artifactId"></param>
<param name="upordown">up / down</param>
<returns>the other tag which its Order got replaced with the input id</returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.MoveTagInItem(System.Guid,System.Guid,System.String)">
<summary>
changes order of tags based on their position in artifact items
</summary>
<param name="tagId"></param>
<param name="itemId"></param>
<param name="upordown">up / down</param>
<returns>the other tag which its Order got replaced with the input id</returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetTagValueBundleByFiendlyUrl(System.String,System.String)">
<summary>
get tag value bundle by frindly url
</summary>
<param name="friendlyUrl"></param>
<param name="valueUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetTagValueByFriendlyUrl(System.Guid,System.String)">
<summary>
get tag value by frindly url
</summary>
<param name="tagId"></param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.NewArtifactTagValue(System.Guid,RMuseum.Models.Artifact.RTag)">
<summary>
add new tag value to artifact
</summary>
<param name="artifactId"></param>
<param name="tag">only name is processed</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.PutAttributeValue(System.Guid,System.Boolean,RMuseum.Models.Artifact.RTagValue)">
<summary>
edit artifact attribute value
</summary>
<remarks>
editable fields are limited
</remarks>
<param name="artifactid"></param>
<param name="tagvalue"></param>
<param name="global">apply on all same value tags</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.RemoveArtifactTagValue(System.Guid,System.Guid)">
<summary>
remove tag from artifact
</summary>
<param name="artifactId"></param>
<param name="tagValueId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.NewItemTagValue(System.Guid,RMuseum.Models.Artifact.RTag)">
<summary>
add new tag value to item
</summary>
<param name="itemId"></param>
<param name="tag">only name is processed</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.PutItemTagValue(System.Guid,System.Boolean,RMuseum.Models.Artifact.RTagValue)">
<summary>
edit item attribute value
</summary>
<remarks>
editable fields are limited
</remarks>
<param name="itemId"></param>
<param name="tagvalue"></param>
<param name="global">apply on all same value tags</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.RemoveItemTagValue(System.Guid,System.Guid)">
<summary>
remove tag from item
</summary>
<param name="itemId"></param>
<param name="tagValueId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.MoveTagValue(System.Guid,System.Guid,System.Guid,System.String)">
<summary>
changes order of tag values based on their position in an artifact
</summary>
<param name="artifactId"></param>
<param name="tagId"></param>
<param name="valueId"></param>
<param name="upordown">up / down</param>
<returns>the other tag which its Order got replaced with the input id</returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.MoveItemTagValue(System.Guid,System.Guid,System.Guid,System.String)">
<summary>
changes order of tag values based on their position in an item
</summary>
<param name="itemId"></param>
<param name="tagId"></param>
<param name="valueId"></param>
<param name="upordown">up / down</param>
<returns>the other tag which its Order got replaced with the input id</returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetArtifactItemByFrienlyUrl(System.String,System.String)">
<summary>
gets specified publish artifact item info (including images + attributes)
</summary>
<param name="artifactUrl"></param>
<param name="itemUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetArtifactItemByFrienlyUrlUserVisible(System.String,System.String)">
<summary>
gets specified publish artifact item info (including images + attributes)
</summary>
<param name="artifactUrl"></param>
<param name="itemUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.Post">
<summary>
Add new artifact (multipart/form-data)
const data = new FormData();
data.append('name', 'تست');
data.append('description', '');
data.append('srcUrl', '');
data.append('picTitle', 'تست');
data.append('picDescription', '');
data.append('file', this.file);
data.append('picSrcUrl', '');
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.Import(System.String,System.String,System.String,System.String)">
<summary>
import from external resources
</summary>
<param name="srcType">loc/princeton/harvard/qajarwomen/hathitrust/penn/cam/bl/folder/walters/cbl</param>
<param name="resourceNumber">119</param>
<param name="friendlyUrl">golestan-baysonghori</param>
<param name="resourcePrefix"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.KeepAlive">
<summary>
keep alive (for import background service)
</summary>
<returns>true</returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.RetryImport">
<summary>
retry import
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.ReExamineLocDownloads(System.String)">
<summary>
due to a bug in loc json outputs some artifacts with more than 1000 pages were downloaded incompletely
</summary>
<param name="pass">123456</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.BookmarkArtifact(System.Guid)">
<summary>
bookmark artifact
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.BookmarkItem(System.Guid)">
<summary>
bookmark item
</summary>
<param name="itemId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.DeleteBookmark(System.Guid)">
<summary>
item bookmarks info
</summary>
<param name="bookmarkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.FavArtifact(System.Guid)">
<summary>
fav artifact
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.FavItem(System.Guid)">
<summary>
fav item
</summary>
<param name="itemId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GeIArtifactUserBookmarks(System.Guid)">
<summary>
artifact bookmarks info
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GeItemUserBookmarks(System.Guid)">
<summary>
item bookmarks info
</summary>
<param name="itemId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserBookmarks(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
user bookmarks
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserFavorites(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
user favorites
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.AddUserNoteToArtifact(RMuseum.Models.Note.ViewModels.PostUserNote)">
<summary>
add note for artifact
</summary>
<param name="note"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.AddUserNoteToArtifactItem(RMuseum.Models.Note.ViewModels.PostUserNote)">
<summary>
add note for artifact item
</summary>
<param name="note"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.EditUserNote(System.Guid,RMuseum.Models.Note.ViewModels.PostUserNote)">
<summary>
Edit User Notes
</summary>
<remarks>a note can not be edited by a user other than its owner or another using having note:moderate permission</remarks>
<param name="noteId"></param>
<param name="note">only htmlContent is processed</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.DeleteUserNote(System.Guid)">
<summary>
delete user notes
</summary>
<remarks>
1. a note can not be deleted by a user other than its owner or another using having note:moderate permission
2. all notes which have refernce to deleting note (sent in reply to it) would be deleted irrelevant of their ownership
</remarks>
<param name="noteId"></param>
<returns>list of notes deleted</returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetArtifactUserNotes(System.Guid)">
<summary>
get private notes for artifact
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetArtifactPublicNotes(System.Guid)">
<summary>
get private notes for artifact
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetArtifactItemUserNotes(System.Guid)">
<summary>
get private notes for artifact item
</summary>
<param name="itemId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetArtifactItemPublicNotes(System.Guid)">
<summary>
get public notes for artifact item
</summary>
<param name="itemId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserPublicNotes(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
user public notes
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserPrivateNotes(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
user public notes
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetAllPublicNotes(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
all users public notes
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.SuggestGanjoorLink(RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion)">
<summary>
suggest ganjoor link
</summary>
<param name="link"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetSuggestedLinks(RMuseum.Models.GanjoorIntegration.ReviewResult,System.Boolean)">
<summary>
get suggested ganjoor links
</summary>
<param name="status"></param>
<param name="notSynced"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.ReviewGanjoorLink(System.Guid,RMuseum.Models.GanjoorIntegration.ReviewResult)">
<summary>
review suggested ganjoor link
</summary>
<param name="linkId"></param>
<param name="result"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.SynchronizeGanjoorLink(System.Guid)">
<summary>
mark suggested ganjoor link as synchronized
</summary>
<param name="linkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.AddTOCForSuggestedLinks">
<summary>
toc / temporary one time api / to be removed
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetSuggestedPinterestLinks(RMuseum.Models.GanjoorIntegration.ReviewResult,System.Boolean)">
<summary>
get suggested pinterest links
</summary>
<param name="status"></param>
<param name="notSynced"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.SuggestPinterestLink(RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion)">
<summary>
suggest pinterest link for ganjoor
</summary>
<param name="suggestion"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.ReviewSuggestedPinterestLink(System.Guid,System.String,RMuseum.Models.GanjoorIntegration.ReviewResult,System.String,System.String)">
<summary>
review suggested ganjoor pinterest link
</summary>
<param name="linkId"></param>
<param name="altText"></param>
<param name="result"></param>
<param name="reviewDesc"></param>
<param name="imageUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.SynchronizeSuggestedPinterestLink(System.Guid)">
<summary>
mark suggested pinterest ganjoor link as synchronized
</summary>
<param name="linkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.GetUserNotifications">
<summary>
Get User Notifications
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.SwitchNotificationStatus(System.Guid)">
<summary>
Switch Notification Status
</summary>
<param name="notificationId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.DeleteNotification(System.Guid)">
<summary>
Delete Notification
</summary>
<param name="notificationId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ArtifactController.#ctor(RMuseum.Services.IArtifactService,RSecurityBackend.Services.IUserPermissionChecker,Microsoft.Extensions.Caching.Memory.IMemoryCache,RSecurityBackend.Services.ICaptchaService,RMuseum.Services.IRNotificationService)">
<summary>
constructor
</summary>
<param name="artifactService">
</param>
<param name="userPermissionChecker"></param>
<param name="memoryCache"></param>
<param name="captchaService"></param>
<param name="notificationService"></param>
</member>
<member name="F:RMuseum.Controllers.ArtifactController._artifactService">
<summary>
Artifact Service
</summary>
</member>
<member name="F:RMuseum.Controllers.ArtifactController._userPermissionChecker">
<summary>
IUserPermissionChecker instance
</summary>
</member>
<member name="F:RMuseum.Controllers.ArtifactController._memoryCache">
<summary>
IMemoryCache
</summary>
</member>
<member name="F:RMuseum.Controllers.ArtifactController._captchaService">
<summary>
Captcha service
</summary>
</member>
<member name="F:RMuseum.Controllers.ArtifactController._notificationService">
<summary>
Notification Service
</summary>
</member>
<member name="T:RMuseum.Controllers.AuditLogController">
<summary>
Audit Log Controller Base
</summary>
</member>
<member name="M:RMuseum.Controllers.AuditLogController.#ctor(RSecurityBackend.Services.IAuditLogService)">
<summary>
constructor
</summary>
<param name="auditLogService">
</param>
</member>
<member name="M:RMuseum.Controllers.GanjoorController.ImportLocalSQLiteDb">
<summary>
imports data from ganjoor SQLite database
</summary>
<returns></returns>
</member>
<member name="F:RMuseum.Controllers.GanjoorController._ganjoorService">
<summary>
Ganjoor Service
</summary>
</member>
<member name="M:RMuseum.Controllers.GanjoorController.#ctor(RMuseum.Services.IGanjoorService)">
<summary>
constructor
</summary>
<param name="ganjoorService"></param>
</member>
<member name="M:RMuseum.Controllers.ImageController.Get(System.Guid,System.String)">
<summary>
returns image stream
</summary>
<param name="id"></param>
<param name="size"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ImageController.Rotate(System.Guid,System.Int32)">
<summary>
Rotate Image in 90 deg. multiplicants: 90, 180 or 270
</summary>
<param name="id"></param>
<param name="degIn90mul"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.ImageController.GenerateCroppedImageBasedOnThumbnailCoordinates(System.Guid,System.Decimal,System.Decimal,System.Decimal,System.Decimal)">
<summary>
Generate Cropped Image Based On ThumbnailCoordinates For Notes
</summary>
<param name="id"></param>
<param name="left"></param>
<param name="top"></param>
<param name="width"></param>
<param name="height"></param>
<returns>id of cropped image</returns>
</member>
<member name="M:RMuseum.Controllers.ImageController.#ctor(RMuseum.Services.IPictureFileService)">
<summary>
constructor
</summary>
<param name="pictureFileService">
</param>
</member>
<member name="F:RMuseum.Controllers.ImageController._pictureFileService">
<summary>
Artifact Service
</summary>
</member>
<member name="M:RMuseum.Controllers.RecitationController.Get(RSecurityBackend.Models.Generic.PagingParameterModel,System.Boolean,RMuseum.Models.GanjoorAudio.AudioReviewStatus)">
<summary>
Gets audio narrations, user must have narration::moderate permission to be able to see all users narrations
</summary>
<param name="paging"></param>
<param name="allUsers">default: false, user must have narration::moderate permission to be able to see all users narrations</param>
<param name="status">default: -1, unfiltered</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetMp3File(System.Int32)">
<summary>
get the corresponding mp3 file for the narration
</summary>
<remarks>
it could be protected (Authorized), but I guess I would have problems with available client components support,
so I preferred it to be anonymous, as it does not harm anybody I guess
</remarks>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetXMLFile(System.Int32)">
<summary>
get the corresponding xml file contemnts (xml) for the narration
</summary>
<remarks>
it could be protected (Authorized), but I guess I would have problems with available client components support,
so I preferred it to be anonymous, as it does not harm anybody I guess
</remarks>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetPoemNarrationVerseSyncArray(System.Int32)">
<summary>
Gets Verse Sync Information
</summary>
<param name="id">narration id</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.UpdatePoemNarration(System.Int32,RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel)">
<summary>
updates narration metadata
</summary>
<param name="id"></param>
<param name="metadata"></param>
<remarks>
reviewstatus cannot be set to Approved or Rejected using this method, use moderate method instead
only these set of fields are updatable: AudioTitle, AudioArtist, AudioArtistUrl, AudioSrc, AudioSrcUrl, ReviewStatus (Draft to Pending and vice versa and Approved/Rejected to Pending)
only narrator or a moderator can update the narration
</remarks>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.ModeratePoemNarration(System.Int32,RMuseum.Models.GanjoorAudio.ViewModels.RecitationModerateViewModel)">
<summary>
Moderate pending narration
</summary>
<param name="id"></param>
<param name="model"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.DeleteRecitation(System.Int32)">
<summary>
Delete a recitation
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetUploads(RSecurityBackend.Models.Generic.PagingParameterModel,System.Boolean)">
<summary>
Get User Uploads
</summary>
<param name="paging"></param>
<param name="allUsers">default: false, user must have narration::moderate permission to be able to see all users uploads</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.UploadReciation(System.Boolean)">
<summary>
Reciation Upload
</summary>
<param name="replace">
if you send true to replace parameter, if there is an existing recitation for the poem from the user with the same Audio Artist name
corresponding mp3+xml files are replaced an no other changes is applied (no new post, preserving recitation position)
</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.MysqlonetimeImport">
<summary>
imports data from ganjoor MySql database
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.RetryPublish">
<summary>
retry publish unpublished narrations
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetUserNarrationProfiles">
<summary>
Get User Profiles
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetUserDefProfile">
<summary>
Get User Default Profile
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.AddUserNarrationProfiles(RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel)">
<summary>
Add a narration profile
</summary>
<param name="profile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.UpdateUserNarrationProfiles(RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel)">
<summary>
Update a narration profile
</summary>
<param name="profile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.DeleteUserNarrationProfiles(System.Guid)">
<summary>
Delete a narration profile
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.GetPublishingQueueStatus(RSecurityBackend.Models.Generic.PagingParameterModel,System.Boolean,System.Boolean)">
<summary>
publishing tracker data
</summary>
<remarks>TODO: Poem Narration Data is not purified yet (includes sensitive information), so it needs a very special permission</remarks>
<param name="paging"></param>
<param name="inProgress"></param>
<param name="finished"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.RecitationController.#ctor(RMuseum.Services.IRecitationService,RSecurityBackend.Services.IUserPermissionChecker)">
<summary>
constructor
</summary>
<param name="audioService"></param>
<param name="userPermissionChecker"></param>
</member>
<member name="F:RMuseum.Controllers.RecitationController._audioService">
<summary>
Artifact Service
</summary>
</member>
<member name="F:RMuseum.Controllers.RecitationController._userPermissionChecker">
<summary>
IUserPermissionChecker instance
</summary>
</member>
<member name="T:RMuseum.Controllers.RImageController">
<summary>
Generic Image Provider
</summary>
</member>
<member name="M:RMuseum.Controllers.RImageController.#ctor(RSecurityBackend.Services.IImageFileService)">
<summary>
constructor
</summary>
<param name="pictureFileService">
</param>
</member>
<member name="T:RMuseum.Controllers.RoleController">
<summary>
roles
</summary>
</member>
<member name="M:RMuseum.Controllers.RoleController.#ctor(RSecurityBackend.Services.IUserRoleService)">
<summary>
constructor
</summary>
<param name="roleService"></param>
</member>
<member name="T:RMuseum.DbContext.RMuseumDbContext">
<summary>
Museum Database Context
</summary>
</member>
<member name="M:RMuseum.DbContext.RMuseumDbContext.#ctor(Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
constructor
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.Configuration">
<summary>
</summary>
</member>
<member name="M:RMuseum.DbContext.RMuseumDbContext.OnConfiguring(Microsoft.EntityFrameworkCore.DbContextOptionsBuilder)">
<summary>
</summary>
<param name="optionsBuilder"></param>
</member>
<member name="M:RMuseum.DbContext.RMuseumDbContext.OnModelCreating(Microsoft.EntityFrameworkCore.ModelBuilder)">
<summary>
</summary>
<param name="builder"></param>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.PictureFiles">
<summary>
Picture Files
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.Tags">
<summary>
Item Attributes
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.Artifacts">
<summary>
Artifacts
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.Items">
<summary>
Items
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.ImportJobs">
<summary>
Import Jobs
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.TagValues">
<summary>
Tags
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.UserBookmarks">
<summary>
User Bookmarks
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.UserNotes">
<summary>
User Notes
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.GanjoorLinks">
<summary>
Ganjoor Links
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.Notifications">
<summary>
Notifications
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.PinterestLinks">
<summary>
Pinterest Links
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.Recitations">
<summary>
Ganjoor Audio Files
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.UploadSessions">
<summary>
Upload Sessions
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.UploadedFiles">
<summary>
Uploaded files
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.UserRecitationProfiles">
<summary>
User Recitation Profiles
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.GanjoorPoets">
<summary>
Ganjoor Poets
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.GanjoorCategories">
<summary>
Ganjoor Categories
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.GanjoorPoems">
<summary>
Ganjoor Poems
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.GanjoorVerses">
<summary>
Ganjoor Verses
</summary>
</member>
<member name="P:RMuseum.DbContext.RMuseumDbContext.RecitationPublishingTrackers">
<summary>
Narration Publishing Tracker
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.PublishStatus">
<summary>
Items or pictures status
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.RArtifactMasterRecordId">
<summary>
parent id
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.Order">
<summary>
Order in Collections
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.FriendlyUrl">
<summary>
Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.Name">
<summary>
Name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.NameInEnglish">
<summary>
Name In English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.Description">
<summary>
Description
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.DescriptionInEnglish">
<summary>
Description In English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.CoverImageIndex">
<summary>
Main Image
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.LastModified">
<summary>
Last Modified for caching purposes
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.Images">
<summary>
All Images
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactItemRecord.Tags">
<summary>
Attributes
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.RArtifactMasterRecord">
<summary>
Museum Master Item
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.FriendlyUrl">
<summary>
Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.Status">
<summary>
Publish Status
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.Name">
<summary>
Name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.NameInEnglish">
<summary>
Name In English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.Description">
<summary>
Description
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.DescriptionInEnglish">
<summary>
Description In English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.DateTime">
<summary>
Date/Time
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.LastModified">
<summary>
Last Modified for caching purposes
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.CoverItemIndex">
<summary>
Cover Item Index
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.CoverImage">
<summary>
Cover Image
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.CoverImageId">
<summary>
Cover Image Id
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.Items">
<summary>
Parts of this item
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.ItemCount">
<summary>
Item Count (for lists and queries)
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RArtifactMasterRecord.Tags">
<summary>
Attributes
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.RPictureFile">
<summary>
Artifact Picture Files
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.Title">
<summary>
Title
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.TitleInEnglish">
<summary>
Title in English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.Description">
<summary>
Description
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.DescriptionInEnglish">
<summary>
Description in English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.Status">
<summary>
Publish status
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.Order">
<summary>
order in the collection it belongs to it
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.NormalSizeImageStoredFileName">
<summary>
نام فایل ذخیره شده با بالاترین کیفیت
</summary>
<example>
e0d7050a-7e30-4a2f-b181-0daa4a1e1068.jpg
</example>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.ThumbnailImageStoredFileName">
<summary>
نام فایل ذخیره شده با بالاترین کیفیت
</summary>
<example>
fbe9cc8e-12fa-4cb9-8f09-bbf353333383.jpg
</example>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.NormalSizeImageWidth">
<summary>
عرض تصویر مناسب نمایش در صفحهٔ اختصاصی
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.NormalSizeImageHeight">
<summary>
طول تصویر مناسب نمایش در صفحهٔ اختصاصی
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.ThumbnailImageWidth">
<summary>
عرض تصویر با اندازه مناسب نمایش در صفحات لیستی
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.ThumbnailImageHeight">
<summary>
طول تصویر با اندازه مناسب نمایش در صفحات لیستی
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.SrcUrl">
<summary>
source url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RPictureFile.LastModifiedMeta">
<summary>
Last Modified for caching purposes
</summary>
</member>
<member name="M:RMuseum.Models.Artifact.RPictureFile.Duplicate(RMuseum.Models.Artifact.RPictureFile)">
<summary>
duplicated a picture record (Id is missing so you should store this to get a new Id)
</summary>
<param name="src"></param>
<returns></returns>
</member>
<member name="T:RMuseum.Models.Artifact.RTag">
<summary>
Item Attribute
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.Order">
<summary>
Order
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.TagType">
<summary>
tag type
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.FriendlyUrl">
<summary>
Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.Status">
<summary>
Publish Status
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.Name">
<summary>
Name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.NameInEnglish">
<summary>
Name In English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.PluralName">
<summary>
Plural Name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.PluralNameInEnglish">
<summary>
Plural Name In English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTag.GlobalValue">
<summary>
Value is normally changed globally
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.RTagType">
<summary>
نوع ویژگی
</summary>
</member>
<member name="F:RMuseum.Models.Artifact.RTagType.Ordinary">
<summary>
عادی
</summary>
</member>
<member name="F:RMuseum.Models.Artifact.RTagType.Link">
<summary>
پیوند
</summary>
</member>
<member name="F:RMuseum.Models.Artifact.RTagType.Search">
<summary>
جستجو
</summary>
</member>
<member name="F:RMuseum.Models.Artifact.RTagType.LinkSearch">
<summary>
پیوند و جستجو
</summary>
</member>
<member name="F:RMuseum.Models.Artifact.RTagType.LeftToRightText">
<summary>
متن چپ به راست
</summary>
</member>
<member name="F:RMuseum.Models.Artifact.RTagType.Binary">
<summary>
بدون مقدار
</summary>
</member>
<member name="F:RMuseum.Models.Artifact.RTagType.TitleInContents">
<summary>
عنوان در فهرست
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.RTagValue">
<summary>
Attribute Value
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTagValue.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTagValue.FriendlyUrl">
<summary>
Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTagValue.Status">
<summary>
Publish Status
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTagValue.Value">
<summary>
Value
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTagValue.ValueInEnglish">
<summary>
Values In English
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.RTagValue.ValueSupplement">
<summary>
link or ....
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.NewArtifact">
<summary>
new artifact view model
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel">
<summary>
RArtifactItemRecord with additional info
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.Item">
<summary>
main item info
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.ParentFriendlyUrl">
<summary>
parent
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.ParentName">
<summary>
parent name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.ParentImageId">
<summary>
parent image
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.ParentItemCount">
<summary>
parent item count
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.NextItemFriendlyUrl">
<summary>
empty or null means this is last item
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.NextItemImageId">
<summary>
next image
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.PreviousItemFriendlyUrl">
<summary>
empty or null means this is first item
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.PrevItemImageId">
<summary>
prev image
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactItemRecordViewModel.FormattedTags">
<summary>
Formatted Tags
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.RArtifactMasterRecordViewModel">
<summary>
Museum Master Item View Model
</summary>
</member>
<member name="M:RMuseum.Models.Artifact.ViewModels.RArtifactMasterRecordViewModel.#ctor(RMuseum.Models.Artifact.RArtifactMasterRecord)">
<summary>
constructor
</summary>
<param name="src"></param>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactMasterRecordViewModel.ArtifactTags">
<summary>
Tags
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactMasterRecordViewModel.RTagSums">
<summary>
Binary Tagged Items
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RArtifactMasterRecordViewModel.Contents">
<summary>
Titles of Items in Contents
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.RArtifactTagViewModel">
<summary>
Artifact Tag (RTag with grouped related RTagValues of Artifact)
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.RTagBundleValueViewModel">
<summary>
Tag Bundle View Model
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleValueViewModel.Name">
<summary>
Item Title
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleValueViewModel.FriendlyUrl">
<summary>
Item Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleValueViewModel.Count">
<summary>
Items Count
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleValueViewModel.ImageId">
<summary>
Item Image Id
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.RTagBundleViewModel">
<summary>
Tag Bundle View Model
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleViewModel.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleViewModel.FriendlyUrl">
<summary>
Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleViewModel.Name">
<summary>
Name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleViewModel.PluralName">
<summary>
Plural Name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagBundleViewModel.Values">
<summary>
Values
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.RTagSum">
<summary>
Artifact Binary Tagged items Summation
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagSum.TagName">
<summary>
Tag Name
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagSum.TagFriendlyUrl">
<summary>
Tag Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTagSum.ItemCount">
<summary>
Item Count
</summary>
</member>
<member name="T:RMuseum.Models.Artifact.ViewModels.RTitleInContents">
<summary>
Title of an Item in Artifact Contents
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTitleInContents.Title">
<summary>
Title
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTitleInContents.Order">
<summary>
Order
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTitleInContents.Level">
<summary>
Level
</summary>
</member>
<member name="P:RMuseum.Models.Artifact.ViewModels.RTitleInContents.ItemFriendlyUrl">
<summary>
Item Friendly Url
</summary>
</member>
<member name="T:RMuseum.Models.Auth.Memory.RMuseumSecurableItem">
<summary>
specific forms and permission
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.ArtifactEntityShortName">
<summary>
artifact
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.TagEntityShortName">
<summary>
tag
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.NoteEntityShortName">
<summary>
note
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.ViewDraftOperationShortName">
<summary>
view drafts
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.EditTagValueOperationShortName">
<summary>
edittag
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.ToAwaitingStatusOperationShortName">
<summary>
awaiting
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.PublishOperationShortName">
<summary>
publish
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.ImportOperationShortName">
<summary>
import
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.ModerateOperationShortName">
<summary>
moderate
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.ReviewGanjoorLinksOperationShortName">
<summary>
review suggested ganjoor links
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.AudioNarrationEntityShortName">
<summary>
audio narrations
</summary>
</member>
<member name="F:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.GanjoorEntityShortName">
<summary>
ganjoor contents
</summary>
</member>
<member name="P:RMuseum.Models.Auth.Memory.RMuseumSecurableItem.Items">
<summary>
list of forms and their permissions
</summary>
</member>
<member name="T:RMuseum.Models.Bookmark.RBookmarkType">
<summary>
Bookmark Type
</summary>
</member>
<member name="F:RMuseum.Models.Bookmark.RBookmarkType.Bookmark">
<summary>
Private Bookmark
</summary>
</member>
<member name="F:RMuseum.Models.Bookmark.RBookmarkType.Favorite">
<summary>
Public Favorite
</summary>
</member>
<member name="T:RMuseum.Models.Bookmark.RUserBookmark">
<summary>
User Bookmarks
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.RAppUserId">
<summary>
User Id
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.RAppUser">
<summary>
User
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.RArtifactMasterRecordId">
<summary>
Master Record Id
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.RArtifactMasterRecord">
<summary>
Master Record
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.RArtifactItemRecordId">
<summary>
Item Record Id
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.RArtifactItemRecord">
<summary>
Item Record
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.DateTime">
<summary>
DateTime
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.RBookmarkType">
<summary>
Type
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.RUserBookmark.Note">
<summary>
User Note
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.ViewModels.RUserBookmarkViewModel.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.ViewModels.RUserBookmarkViewModel.RAppUserId">
<summary>
User Id
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.ViewModels.RUserBookmarkViewModel.RArtifactMasterRecord">
<summary>
Master Record
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.ViewModels.RUserBookmarkViewModel.RArtifactItemRecord">
<summary>
Item Record
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.ViewModels.RUserBookmarkViewModel.DateTime">
<summary>
DateTime
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.ViewModels.RUserBookmarkViewModel.RBookmarkType">
<summary>
Type
</summary>
</member>
<member name="P:RMuseum.Models.Bookmark.ViewModels.RUserBookmarkViewModel.Note">
<summary>
User Note
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.AudioReviewStatus">
<summary>
Audio Review Status
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioReviewStatus.All">
<summary>
All / Unfiltered (for queris)
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioReviewStatus.Draft">
<summary>
Draft
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioReviewStatus.Pending">
<summary>
pending for review
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioReviewStatus.Approved">
<summary>
approved
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioReviewStatus.Rejected">
<summary>
Rejected
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.AudioSyncStatus">
<summary>
Audio Synchronization Status (binary combination is acceptable)
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioSyncStatus.SynchronizedOrRejected">
<summary>
no changed
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioSyncStatus.NewItem">
<summary>
new upload
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioSyncStatus.MetadataChanged">
<summary>
meta data should be updated
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioSyncStatus.SoundFilesChanged">
<summary>
sound files should be reuploaded (this means xml file is also needs to reuploaded)
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioSyncStatus.XmlFileChanged">
<summary>
Xml file should be reuploaded
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.AudioSyncStatus.Deleted">
<summary>
Item should be deleted
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.Recitation">
<summary>
Poem Narration
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.Owner">
<summary>
Owner User
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.OwnerId">
<summary>
Owner User Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.GanjoorAudioId">
<summary>
Final data is actually exported to a MySQL database which this auto increment field is its key
</summary>
<remarks>
Caution: this could become a relation with newly added table <see cref="T:RMuseum.Models.Ganjoor.GanjoorPoem"/>
but if we do this we lose the ability to drop and create <see cref="T:RMuseum.Models.Ganjoor.GanjoorPoem"/> without losing narration data
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.AudioOrder">
<summary>
This determines where an audio is displayed between a list of sounds related to a specfic poem
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.FileNameWithoutExtension">
<summary>
Using this field content you would determine xml, mp3 and ogg file names
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.SoundFilesFolder">
<summary>
combining this with <see cref="P:RMuseum.Models.GanjoorAudio.Recitation.FileNameWithoutExtension"/> + .ext would preduce relative path of sound files on our file server the full path would become [HOMEPath] + '/i/' + this value
</summary>
<sample>
"a2"
</sample>
<remarks>
We had previously used different pathes because when a directory became overcrowded our connection time would increase unbearably due to IRAN internet problems, so it is sensible to store it per record and not as a global option value
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.RemoteMp3FilePath">
<summary>
MP3 File Path
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.Mp3Url">
<summary>
MP3 url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.RemoteOggFilePath">
<summary>
OGG File Path
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.OggUrl">
<summary>
OGG url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.RemoteXMLFilePath">
<summary>
This is also a legacy field
</summary>
<sample>
"/i/a2/x"
</sample>
<remarks>
XML Schema is defined based on Desktop Ganjoor (https://github.com/ganjoor/ganjoor) code, for
more information take a look at this code:
https://github.com/ganjoor/ganjoor/blob/master/ganjoor/Audio%20Support/PoemAudioListProcessor.cs
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.XMLUrl">
<summary>
XML url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.AudioTitle">
<summary>
Audio Title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.AudioArtist">
<summary>
Audio Artist
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.AudioArtistUrl">
<summary>
Audio Artist Url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.AudioSrc">
<summary>
Audio Source
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.AudioSrcUrl">
<summary>
Audio Src Url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.LegacyAudioGuid">
<summary>
Legacy Audio Guid
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.Mp3FileCheckSum">
<summary>
Audio File CheckSum
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.Mp3SizeInBytes">
<summary>
mp3 size in bytes
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.OggSizeInBytes">
<summary>
ogg size in bytes
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.UploadDate">
<summary>
Upload Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.FileLastUpdated">
<summary>
File Last Updated
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.ReviewDate">
<summary>
Review Date (Approve or Reject)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.LocalMp3FilePath">
<summary>
MP3 File local path on Windows Server (if item is not rejected probably it is not valid and it is deleted)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.LocalXmlFilePath">
<summary>
XML File local path on Windows Server (if item is not rejected probably it is not valid and it is deleted)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.AudioSyncStatus">
<summary>
Value is one or a combination of <see cref="T:RMuseum.Models.GanjoorAudio.AudioSyncStatus"/>
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.ReviewStatus">
<summary>
Review Status
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.Reviewer">
<summary>
Reviewer user
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.ReviewerId">
<summary>
Reviewer user
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.Recitation.ReviewMsg">
<summary>
Review Message
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker">
<summary>
Narration Publishing Tracker
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.PoemNarrationId">
<summary>
Poem Narration Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.PoemNarration">
<summary>
Poem Narration
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.StartDate">
<summary>
Start Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.XmlFileCopied">
<summary>
XML File Copied
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.Mp3FileCopied">
<summary>
MP3 File Copied
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.FirstDbUpdated">
<summary>
First MySql DB Updated
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.SecondDbUpdated">
<summary>
Second DB Updated
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.Finished">
<summary>
Finished
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.FinishDate">
<summary>
Finish Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.RecitationPublishingTracker.LastException">
<summary>
Last Excecption
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.UserRecitationProfile">
<summary>
Narration Profiles for users
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.User">
<summary>
User
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.UserId">
<summary>
UserId
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.Name">
<summary>
Profile Name
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.FileSuffixWithoutDash">
<summary>
this would be appended to audio files names prefixed by a dash to make them unique and specfic to user
filenames usually would look like {GanjoorPostId}-{FileSuffixWithoutDash}.{ext}
for example 2200-hrm.xml
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.ArtistName">
<summary>
artist name
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.ArtistUrl">
<summary>
artist url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.AudioSrc">
<summary>
audio src
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.AudioSrcUrl">
<summary>
audio src url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.UserRecitationProfile.IsDefault">
<summary>
is default
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.ViewModels.PoemNarrationModerationResult">
<summary>
Moderation Result
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.ViewModels.PoemNarrationModerationResult.MetadataNeedsFixation">
<summary>
no moderation
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.ViewModels.PoemNarrationModerationResult.Approve">
<summary>
approve
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorAudio.ViewModels.PoemNarrationModerationResult.Reject">
<summary>
reject
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.ViewModels.RecitationModerateViewModel">
<summary>
Poem Narration Moderation View Model
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationModerateViewModel.Result">
<summary>
Moderation Result
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationModerateViewModel.Message">
<summary>
Rejection Message
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.ViewModels.RecitationVerseSync">
<summary>
Verse Sync Range
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationVerseSync.VerseOrder">
<summary>
Verse Order
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationVerseSync.VerseText">
<summary>
Verse Text
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationVerseSync.AudioStartMilliseconds">
<summary>
Audio Start in Milliseconds
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel">
<summary>
Poem Narration view model
</summary>
</member>
<member name="M:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.#ctor">
<summary>
parameterless constructor for deserialization support
</summary>
</member>
<member name="M:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.#ctor(RMuseum.Models.GanjoorAudio.Recitation,RSecurityBackend.Models.Auth.Db.RAppUser,RMuseum.Models.Ganjoor.GanjoorPoem)">
<summary>
constructor
</summary>
<param name="src"></param>
<param name="owner"></param>
<param name="poem"></param>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.Owner">
<summary>
Owner User
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.GanjoorAudioId">
<summary>
Final data is actually exported to a MySQL database which this auto increment field is its key
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.PoemFullTitle">
<summary>
Poem Full Title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.PoemFullUrl">
<summary>
Poem Full Url (without domain name)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.AudioOrder">
<summary>
This determines where an audio is displayed between a list of sounds related to a specfic poem
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.FileNameWithoutExtension">
<summary>
Using this field content you would determine xml, mp3 and ogg file names
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.SoundFilesFolder">
<summary>
combining this with <see cref="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.FileNameWithoutExtension"/> + .ext would preduce relative path of sound files on our file server the full path would become [HOMEPath] + '/i/' + this value
</summary>
<sample>
"a2"
</sample>
<remarks>
We had previously used different pathes because when a directory became overcrowded our connection time would increase unbearably due to IRAN internet problems, so it is sensible to store it per record and not as a global option value
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.RemoteMp3FilePath">
<summary>
MP3 File Path
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.Mp3Url">
<summary>
MP3 url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.RemoteOggFilePath">
<summary>
OGG File Path
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.OggUrl">
<summary>
OGG url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.RemoteXMLFilePath">
<summary>
This is also a legacy field
</summary>
<sample>
"/i/a2/x"
</sample>
<remarks>
XML Schema is defined based on Desktop Ganjoor (https://github.com/ganjoor/ganjoor) code, for
more information take a look at this code:
https://github.com/ganjoor/ganjoor/blob/master/ganjoor/Audio%20Support/PoemAudioListProcessor.cs
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.XMLUrl">
<summary>
XML url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.AudioTitle">
<summary>
Audio Title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.AudioArtist">
<summary>
Audio Artist
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.AudioArtistUrl">
<summary>
Audio Artist Url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.AudioSrc">
<summary>
Audio Source
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.AudioSrcUrl">
<summary>
Audio Src Url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.LegacyAudioGuid">
<summary>
Legacy Audio Guid
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.Mp3FileCheckSum">
<summary>
Audio File CheckSum
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.Mp3SizeInBytes">
<summary>
mp3 size in bytes
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.OggSizeInBytes">
<summary>
ogg size in bytes
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.UploadDate">
<summary>
Upload Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.FileLastUpdated">
<summary>
File Last Updated
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.ReviewDate">
<summary>
Review Date (Approve or Reject)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.LocalMp3FilePath">
<summary>
MP3 File local path on Windows Server (if item is not rejected probably it is not valid and it is deleted)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.LocalXmlFilePath">
<summary>
XML File local path on Windows Server (if item is not rejected probably it is not valid and it is deleted)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.AudioSyncStatusArray">
<summary>
Value is one or a combination of <see cref="T:RMuseum.Models.GanjoorAudio.AudioSyncStatus"/>
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.ReviewStatus">
<summary>
Review Status
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel.ReviewMsg">
<summary>
Review Message
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel">
<summary>
UserNarrationProfile View Model
</summary>
</member>
<member name="M:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.#ctor">
<summary>
parameterless constructor
</summary>
</member>
<member name="M:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.#ctor(RMuseum.Models.GanjoorAudio.UserRecitationProfile)">
<summary>
constructor
</summary>
<param name="src"></param>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.Id">
<summary>
Id
</summary>
<remarks>
Do not fill it in POST api
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.User">
<summary>
User
</summary>
<remarks>
Do not fill it in POST api
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.UserId">
<summary>
UserId
</summary>
<remarks>
Do not fill it in POST api
</remarks>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.Name">
<summary>
Profile Name
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.FileSuffixWithoutDash">
<summary>
this would be appended to audio files names prefixed by a dash to make them unique and specfic to user
filenames usually would look like {GanjoorPostId}-{FileSuffixWithoutDash}.{ext}
for example 2200-hrm.xml
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.ArtistName">
<summary>
artist name
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.ArtistUrl">
<summary>
artist url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.AudioSrc">
<summary>
audio src
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.AudioSrcUrl">
<summary>
audio src url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel.IsDefault">
<summary>
is default
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.GanjoorLink">
<summary>
ganjoor link for artifacts and items
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.GanjoorUrl">
<summary>
ganjoor url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.GanjoorTitle">
<summary>
ganjoor title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.ArtifactId">
<summary>
Artifact Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.Artifact">
<summary>
artifact
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.ItemId">
<summary>
Artifact Item Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.Item">
<summary>
Artifact Item
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.SuggestedById">
<summary>
User Id who suggested the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.SuggestionDate">
<summary>
Suggestion Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.SuggestedBy">
<summary>
User who suggested the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.ReviewerId">
<summary>
User id who reviewed the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.Reviewer">
<summary>
User who reviewed the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.ReviewDate">
<summary>
Review Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.ReviewResult">
<summary>
review result
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.GanjoorLink.Synchronized">
<summary>
Synchronized with ganjoor
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.LinkType">
<summary>
Link Type
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorIntegration.LinkType.Custom">
<summary>
Custom
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorIntegration.LinkType.Museum">
<summary>
Museum
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorIntegration.LinkType.Pinterest">
<summary>
Pinterest
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorIntegration.LinkType.Instagram">
<summary>
Instagram
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.PinterestLink">
<summary>
pinterest link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.GanjoorUrl">
<summary>
ganjoor url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.GanjoorTitle">
<summary>
ganjoor title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.AltText">
<summary>
alt text
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.LinkType">
<summary>
link type
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.PinterestUrl">
<summary>
pinterest url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.PinterestImageUrl">
<summary>
pinterest image url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.SuggestedById">
<summary>
User Id who suggested the link (this would always be null for anonyous suggestions, kept it so that someday it would be used to integerate GanjoorLink into this class)
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.SuggestionDate">
<summary>
Suggestion Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.SuggestedBy">
<summary>
User who suggested the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.ReviewerId">
<summary>
User id who reviewed the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.Reviewer">
<summary>
User who reviewed the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.ReviewDate">
<summary>
Review Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.ReviewResult">
<summary>
review result
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.ReviewDesc">
<summary>
review description
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.ArtifactId">
<summary>
Artifact Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.Artifact">
<summary>
artifact
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.ItemId">
<summary>
Artifact Item Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.Item">
<summary>
Artifact Item
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.PinterestLink.Synchronized">
<summary>
Synchronized with ganjoor
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.ReviewResult">
<summary>
Review Result
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorIntegration.ReviewResult.Awaiting">
<summary>
Awaiting (default)
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorIntegration.ReviewResult.Approved">
<summary>
Approved
</summary>
</member>
<member name="F:RMuseum.Models.GanjoorIntegration.ReviewResult.Rejected">
<summary>
Rejected
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel">
<summary>
Ganjoor Link View Model
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.GanjoorUrl">
<summary>
ganjoor url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.GanjoorTitle">
<summary>
ganjoor title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.EntityName">
<summary>
entity name
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.EntityFriendlyUrl">
<summary>
entity friendly url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.EntityImageId">
<summary>
entity image id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.ReviewResult">
<summary>
review result
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.Synchronized">
<summary>
Synchronized with ganjoor
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.GanjoorLinkViewModel.SuggestedBy">
<summary>
suggested by
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion">
<summary>
Link Suggestion
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion.GanjoorUrl">
<summary>
ganjoor url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion.GanjoorTitle">
<summary>
ganjoor title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion.ArtifactFriendlyUrl">
<summary>
Artifact Friendly Url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion.ItemId">
<summary>
Artifact Item Id
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel">
<summary>
Safe pinterest link view model
</summary>
</member>
<member name="M:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.#ctor(RMuseum.Models.GanjoorIntegration.PinterestLink,System.String,System.String,System.Guid)">
<summary>
cosntructor
</summary>
<param name="src"></param>
<param name="entityFriendlyUrl"></param>
<param name="entityImageId"></param>
<param name="entityName"></param>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.GanjoorUrl">
<summary>
ganjoor url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.GanjoorTitle">
<summary>
ganjoor title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.AltText">
<summary>
alt text
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.LinkType">
<summary>
link type
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.PinterestUrl">
<summary>
pinterest url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.PinterestImageUrl">
<summary>
pinterest image url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.SuggestionDate">
<summary>
Suggestion Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.ReviewerId">
<summary>
User id who reviewed the link
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.ReviewDate">
<summary>
Review Date
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.ReviewResult">
<summary>
review result
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.ReviewDesc">
<summary>
review description
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.ArtifactId">
<summary>
Artifact Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.ItemId">
<summary>
Artifact Item Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.Synchronized">
<summary>
Synchronized with ganjoor
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.EntityName">
<summary>
entity name
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.EntityFriendlyUrl">
<summary>
entity friendly url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestLinkViewModel.EntityImageId">
<summary>
entity image id
</summary>
</member>
<member name="T:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion">
<summary>
pinterest / ganjoor link suggestion view model
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.GanjoorPostId">
<summary>
Ganjoor Post Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.GanjoorUrl">
<summary>
ganjoor url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.GanjoorTitle">
<summary>
ganjoor title
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.AltText">
<summary>
alt text
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.LinkType">
<summary>
link type
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.PinterestUrl">
<summary>
pinterest url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.PinterestImageUrl">
<summary>
pinterest image url
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.CaptchaImageId">
<summary>
Captcha Image Id
</summary>
</member>
<member name="P:RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion.CaptchaValue">
<summary>
Captcha Value
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.GanjoorCat">
<summary>
Ganjoor Category
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.Id">
<summary>
id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.PoetId">
<summary>
poet_id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.Poet">
<summary>
poet
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.Title">
<summary>
text
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.ParentId">
<summary>
parent_id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.Parent">
<summary>
parent
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.UrlSlug">
<summary>
url => slug
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorCat.FullUrl">
<summary>
sample: /hafez/ghazal
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.GanjoorPoem">
<summary>
Ganjoor Poem
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoem.Id">
<summary>
id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoem.CatId">
<summary>
cat-id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoem.Cat">
<summary>
cat
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoem.Title">
<summary>
title
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoem.FullTitle">
<summary>
cat + parent cats title + title
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoem.UrlSlug">
<summary>
url => slug
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoem.FullUrl">
<summary>
sample: /hafez/ghazal/sh1
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.GanjoorPoet">
<summary>
Ganjoor Poet
</summary>
<remarks>
cat_id field is removed, it is retrievable by querying <see cref="T:RMuseum.Models.Ganjoor.GanjoorCat"/>
where <see cref="P:RMuseum.Models.Ganjoor.GanjoorCat.PoetId"/> == <see cref="P:RMuseum.Models.Ganjoor.GanjoorPoet.Id"/> and
<see cref="P:RMuseum.Models.Ganjoor.GanjoorCat.Parent"/> == null
</remarks>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoet.Id">
<summary>
id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoet.Name">
<summary>
name
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorPoet.Description">
<summary>
description
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.GanjoorVerse">
<summary>
Ganjoor Verse
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorVerse.Id">
<summary>
global id, auto generated (missing in Ganjoor Desktop database)
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorVerse.PoemId">
<summary>
poem_id
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorVerse.Poem">
<summary>
poem
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorVerse.VOrder">
<summary>
vorder
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorVerse.VersePosition">
<summary>
position
</summary>
</member>
<member name="P:RMuseum.Models.Ganjoor.GanjoorVerse.Text">
<summary>
text
</summary>
</member>
<member name="T:RMuseum.Models.Ganjoor.VersePosition">
<summary>
معنی فیلد position در جدول verse با توجه به مقادیر این ساختار داده مشخص می شود.
</summary>
<remarks>
imported from Desktop Ganjoor source
</remarks>
</member>
<member name="F:RMuseum.Models.Ganjoor.VersePosition.Right">
<summary>
First Verse in a normal Beyt
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.VersePosition.Left">
<summary>
Second Verse in a normal Beyt
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.VersePosition.CenteredVerse1">
<summary>
First Verse or the only one in a Band Beyt
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.VersePosition.CenteredVerse2">
<summary>
Second Verse in a Band Beyt
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.VersePosition.Single">
<summary>
Free form verse
</summary>
</member>
<member name="F:RMuseum.Models.Ganjoor.VersePosition.Paragraph">
<summary>
Non-poem paragraph
</summary>
</member>
<member name="T:RMuseum.Models.ImportJob.ImportJob">
<summary>
Import Job
</summary>
</member>
<member name="T:RMuseum.Models.ImportJob.JobType">
<summary>
Job Type
</summary>
</member>
<member name="T:RMuseum.Models.Note.RNoteType">
<summary>
Note Type
</summary>
</member>
<member name="F:RMuseum.Models.Note.RNoteType.Private">
<summary>
private
</summary>
</member>
<member name="F:RMuseum.Models.Note.RNoteType.Public">
<summary>
public
</summary>
</member>
<member name="T:RMuseum.Models.Note.RUserNote">
<summary>
User Note
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.RAppUserId">
<summary>
User Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.RAppUser">
<summary>
User
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.RArtifactMasterRecordId">
<summary>
Master Record Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.RArtifactMasterRecord">
<summary>
Master Record
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.RArtifactItemRecordId">
<summary>
Item Record Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.RArtifactItemRecord">
<summary>
Item Record
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.DateTime">
<summary>
DateTime
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.Modified">
<summary>
Is Updated by User
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.LastModified">
<summary>
Last Modified
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.NoteType">
<summary>
Private / Public
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.HtmlContent">
<summary>
content
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.ReferenceNote">
<summary>
In Reply to Other Note
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.ReferenceNoteId">
<summary>
Reference Note Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.RUserNote.Status">
<summary>
Status
</summary>
</member>
<member name="T:RMuseum.Models.Note.ViewModels.PostUserNote">
<summary>
New User Note For Artifact
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.PostUserNote.EntityId">
<summary>
Artifact / Item Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.PostUserNote.NoteType">
<summary>
Note Type
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.PostUserNote.Contents">
<summary>
Contents
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.PostUserNote.ReferenceNoteId">
<summary>
Reference Note Id
</summary>
</member>
<member name="T:RMuseum.Models.Note.ViewModels.RUserNoteViewModel">
<summary>
Safe User Note View Model
</summary>
</member>
<member name="M:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.#ctor(RMuseum.Models.Note.RUserNote,RSecurityBackend.Models.Auth.ViewModels.PublicRAppUser)">
<summary>
Constructor
</summary>
<param name="src"></param>
<param name="user"></param>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.RAppUserId">
<summary>
User Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.UserName">
<summary>
User Name (FirstName + SureName)
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.RUserImageId">
<summary>
user image id
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.DateTime">
<summary>
DateTime
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.Modified">
<summary>
Is Updated by User
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.LastModified">
<summary>
Last Modified
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.NoteType">
<summary>
Private / Public
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.HtmlContent">
<summary>
content
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.ReferenceNoteId">
<summary>
Reference Note Id
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.Status">
<summary>
Status
</summary>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.RelatedEntityName">
<summary>
Related Entity (Artifact/Item) Name
</summary>
<remarks>
It is set only in cummulative api calls
</remarks>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.RelatedEntityImageId">
<summary>
Realated entity Image Id
</summary>
<remarks>
It is set only in cummulative api calls
</remarks>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.RelatedEntityFriendlyUrl">
<summary>
Realated entity Friendly Url (for artifact items it would be ParentFiendlyUrl/ItemFriendlyUrl )
</summary>
<remarks>
It is set only in cummulative api calls
</remarks>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.RelatedItemParentName">
<summary>
Related Item Artifact Name
</summary>
<remarks>
It is set only in cummulative api calls
</remarks>
</member>
<member name="P:RMuseum.Models.Note.ViewModels.RUserNoteViewModel.Notes">
<summary>
child notes
</summary>
<remarks>
It os set only in certain cases
</remarks>
</member>
<member name="T:RMuseum.Models.Notification.NotificationStatus">
<summary>
Notifaction Status
</summary>
</member>
<member name="T:RMuseum.Models.Notification.RUserNotification">
<summary>
User Notification
</summary>
</member>
<member name="P:RMuseum.Models.Notification.RUserNotification.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.Notification.RUserNotification.UserId">
<summary>
User Id
</summary>
</member>
<member name="P:RMuseum.Models.Notification.RUserNotification.User">
<summary>
User
</summary>
</member>
<member name="P:RMuseum.Models.Notification.RUserNotification.DateTime">
<summary>
DateTime
</summary>
</member>
<member name="P:RMuseum.Models.Notification.RUserNotification.Status">
<summary>
Status
</summary>
</member>
<member name="P:RMuseum.Models.Notification.RUserNotification.Subject">
<summary>
Subject
</summary>
</member>
<member name="P:RMuseum.Models.Notification.RUserNotification.HtmlText">
<summary>
Text
</summary>
</member>
<member name="T:RMuseum.Models.UploadSession.UploadSession">
<summary>
Upload Session
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.SessionType">
<summary>
Session Type
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.User">
<summary>
User
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.UseId">
<summary>
User Id
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.UploadStartTime">
<summary>
Upload Start Time
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.UploadEndTime">
<summary>
Upload End Time
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.ProcessStartTime">
<summary>
Process Start Time
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.ProcessEndTime">
<summary>
Process End Time
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.ProcessProgress">
<summary>
Process Progress
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.Status">
<summary>
Status
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSession.UploadedFiles">
<summary>
Uploaded Files
</summary>
</member>
<member name="T:RMuseum.Models.UploadSession.UploadSessionFile">
<summary>
Upload Session File
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.Id">
<summary>
Id
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.UploadSessionId">
<summary>
Upload Session Id
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.ContentDisposition">
<summary>
ContentDisposition
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.ContentType">
<summary>
ContentType
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.FileName">
<summary>
FileName
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.Length">
<summary>
Length
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.Name">
<summary>
Name
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.FilePath">
<summary>
File Path
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.MP3FileCheckSum">
<summary>
File check sum for mp3 files
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.ProcessResult">
<summary>
Process Result
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.UploadSessionFile.ProcessResultMsg">
<summary>
Process Result Message
</summary>
</member>
<member name="T:RMuseum.Models.UploadSession.UploadSessionProcessStatus">
<summary>
Upload Session Process Status
</summary>
</member>
<member name="F:RMuseum.Models.UploadSession.UploadSessionProcessStatus.NotStarted">
<summary>
Not Started
</summary>
</member>
<member name="F:RMuseum.Models.UploadSession.UploadSessionProcessStatus.Started">
<summary>
Started
</summary>
</member>
<member name="F:RMuseum.Models.UploadSession.UploadSessionProcessStatus.Finished">
<summary>
Finished
</summary>
</member>
<member name="T:RMuseum.Models.UploadSession.UploadSessionType">
<summary>
Upload Session Types
</summary>
</member>
<member name="F:RMuseum.Models.UploadSession.UploadSessionType.Generic">
<summary>
Generic
</summary>
</member>
<member name="F:RMuseum.Models.UploadSession.UploadSessionType.NewAudio">
<summary>
New Audio
</summary>
</member>
<member name="F:RMuseum.Models.UploadSession.UploadSessionType.ReplaceAudio">
<summary>
New or replace audio
</summary>
</member>
<member name="T:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel">
<summary>
Uploaded Item View Model
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.FileName">
<summary>
filename
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.ProcessResult">
<summary>
process result
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.ProcessResultMsg">
<summary>
process result message
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.UploadEndTime">
<summary>
Upload End Time
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.UserName">
<summary>
Upload User Name
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.ProcessStartTime">
<summary>
Process Start Time
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.ProcessProgress">
<summary>
progress progress
</summary>
</member>
<member name="P:RMuseum.Models.UploadSession.ViewModels.UploadedItemViewModel.ProcessEndTime">
<summary>
process end time
</summary>
</member>
<member name="T:RMuseum.Services.IArtifactService">
<summary>
Artifact Item Service
</summary>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetAll(RSecurityBackend.Models.Generic.PagingParameterModel,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
get all artifacts (including CoverImage info but not items or attributes info)
</summary>
<param name="paging"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetByTagValue(System.String,System.String,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
get tagged publish artifacts (including CoverImage info but not items or tagibutes info)
</summary>
<param name="tagUrl"></param>
<param name="valueUrl"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetByFriendlyUrl(System.String,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
gets specified artifact info (including CoverImage + images + attributes)
</summary>
<param name="friendlyUrl"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetByFriendlyUrlFilterItemsByTag(System.String,RMuseum.Models.Artifact.PublishStatus[],System.String,System.String)">
<summary>
gets specified artifact info (including CoverImage + images + tagibutes)
</summary>
<param name="friendlyUrl"></param>
<param name="statusArray"></param>
<param name="tagFriendlyUrl"></param>
<param name="tagValueFriendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditMasterRecord(RMuseum.Models.Artifact.RArtifactMasterRecord,System.Boolean,System.Boolean)">
<summary>
edit master record
</summary>
<param name="edited"></param>
<param name="canChangeStatusToAwaiting"></param>
<param name="canPublish"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.SetArtifactCoverItemIndex(System.Guid,System.Int32)">
<summary>
Set Artifact Cover Item Index
</summary>
<param name="artifactId"></param>
<param name="itemIndex"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetTagBundleByFiendlyUrl(System.String)">
<summary>
get tag bundle by frindly url
</summary>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetMaxArtifactLastModified">
<summary>
get max lastmodified artifact date for caching purposes
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetAllTags(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
get all tags
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetTagByFriendlyUrl(System.String)">
<summary>
get tag bu friendly url
</summary>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.AddTag(System.String)">
<summary>
add tag
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditTag(RMuseum.Models.Artifact.RTag)">
<summary>
edit tag
</summary>
<param name="edited"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditTagOrderBasedOnArtifact(System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tags based on their position in artifacts
</summary>
<param name="tagId"></param>
<param name="artifactId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditTagOrderBasedOnItem(System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tags based on their position in artifact items
</summary>
<param name="tagId"></param>
<param name="itemId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.TagArtifact(System.Guid,RMuseum.Models.Artifact.RTag)">
<summary>
add artifact tag value
</summary>
<param name="artifactId"></param>
<param name="tag"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditTagValueOrder(System.Guid,System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tag values based on their position in an artifact
</summary>
<param name="artifactId"></param>
<param name="tagId"></param>
<param name="valueId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag value which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditItemTagValueOrder(System.Guid,System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tag values based on their position in an item
</summary>
<param name="itemId"></param>
<param name="tagId"></param>
<param name="valueId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag value which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetTagValueBundleByFiendlyUrl(System.String,System.String)">
<summary>
get tag value bundle by frindly url
</summary>
<param name="friendlyUrl"></param>
<param name="valueUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetTagValueByFriendlyUrl(System.Guid,System.String)">
<summary>
get tag value by frindly url
</summary>
<param name="tagId"></param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditTagValue(System.Guid,RMuseum.Models.Artifact.RTagValue,System.Boolean)">
<summary>
edit artifact tagibute value
</summary>
<param name="artifactId"></param>
<param name="edited"></param>
<param name="global">apply on all same value tags</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.UnTagArtifact(System.Guid,System.Guid)">
<summary>
remove artfiact tag value
</summary>
<param name="artifactId"></param>
<param name="tagValueId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.TagItem(System.Guid,RMuseum.Models.Artifact.RTag)">
<summary>
add item tag value
</summary>
<param name="itemId"></param>
<param name="tag"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditItemTagValue(System.Guid,RMuseum.Models.Artifact.RTagValue,System.Boolean)">
<summary>
edit item tag value
</summary>
<param name="itemId"></param>
<param name="edited"></param>
<param name="global">apply on all same value tags</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.UnTagItem(System.Guid,System.Guid)">
<summary>
remove item tag value
</summary>
<param name="itemId"></param>
<param name="tagValueId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetArtifactItemByFrienlyUrl(System.String,System.String,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
gets specified artifact item info (including images + attributes)
</summary>
<param name="artifactUrl"></param>
<param name="itemUrl"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.Add(System.String,System.String,System.String,System.String,System.String,Microsoft.AspNetCore.Http.IFormFile,System.String,System.IO.Stream)">
<summary>
add new artifact
</summary>
<param name="name"></param>
<param name="description"></param>
<param name="srcurl"></param>
<param name="pictitle"></param>
<param name="picdescription"></param>
<param name="file"></param>
<param name="picsrcurl"></param>
<param name="stream"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.Import(System.String,System.String,System.String,System.String)">
<summary>
import from external resources
</summary>
<param name="srcType">loc/princeton/harvard/qajarwomen/hathitrust/penn/cam/bl/folder/walters/cbl</param>
<param name="resourceNumber">119</param>
<param name="friendlyUrl">golestan-baysonghori</param>
<param name="resourcePrefix"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.RescheduleJobs">
<summary>
reschedule jobs
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.ReExamineLocDownloads">
<summary>
due to a bug in loc json outputs some artifacts with more than 1000 pages were downloaded incompletely
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetImportJobs(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
import jobs
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.BookmarkArtifact(System.Guid,System.Guid,RMuseum.Models.Bookmark.RBookmarkType)">
<summary>
Bookmark Artifact
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetArtifactUserBookmarks(System.Guid,System.Guid)">
<summary>
get artifact user bookmarks
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.BookmarkItem(System.Guid,System.Guid,RMuseum.Models.Bookmark.RBookmarkType)">
<summary>
Bookmark Item
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GeItemUserBookmarks(System.Guid,System.Guid)">
<summary>
get item user bookmarks
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.UpdateUserBookmark(System.Guid,System.String)">
<summary>
update bookmark note
</summary>
<param name="bookmarkId"></param>
<param name="note"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.DeleteUserBookmark(System.Guid)">
<summary>
delete user bookmark
/// </summary>
<param name="bookmarkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetBookmarks(RSecurityBackend.Models.Generic.PagingParameterModel,System.Guid,RMuseum.Models.Bookmark.RBookmarkType,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
get user bookmarks (artifacts and items)
</summary>
<param name="paging"></param>
<param name="userId"></param>
<param name="type"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.AddUserNoteToArtifact(System.Guid,System.Guid,RMuseum.Models.Note.RNoteType,System.String,System.Nullable{System.Guid})">
<summary>
Add Note to Artifact
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<param name="type"></param>
<param name="noteContents"></param>
<param name="referenceNoteId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.AddUserNoteToArtifactItem(System.Guid,System.Guid,RMuseum.Models.Note.RNoteType,System.String,System.Nullable{System.Guid})">
<summary>
Add Note to Artifact Item
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<param name="type"></param>
<param name="noteContents"></param>
<param name="referenceNoteId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.EditUserNote(System.Guid,System.Nullable{System.Guid},System.String)">
<summary>
Edit Note
</summary>
<param name="noteId"></param>
<param name="userId">sending null here means user is a moderator</param>
<param name="noteContents"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.DeleteUserNote(System.Guid,System.Nullable{System.Guid})">
<summary>
delete note
</summary>
<param name="noteId"></param>
<param name="userId">sending null here means user is a moderator or the note is being deleted in a recursive delete of referenced notes</param>
<returns>list of notes deleted</returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetArtifactUserNotes(System.Guid,System.Guid)">
<summary>
get artifact private user notes
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetArtifactPublicNotes(System.Guid)">
<summary>
get artifact public user notes
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetArtifactItemUserNotes(System.Guid,System.Guid)">
<summary>
get item artifact private user notes
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetArtifactItemPublicNotes(System.Guid)">
<summary>
get item artifact item public user notes
</summary>
<param name="itemId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetUserNotes(System.Guid,RSecurityBackend.Models.Generic.PagingParameterModel,RMuseum.Models.Note.RNoteType,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
Get All USer Notes
</summary>
<param name="userId"></param>
<param name="paging"></param>
<param name="type"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetAllPublicNotes(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
Get All Public Notes
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.SuggestGanjoorLink(System.Guid,RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion)">
<summary>
suggest ganjoor link
</summary>
<param name="userId"></param>
<param name="link"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetSuggestedLinks(RMuseum.Models.GanjoorIntegration.ReviewResult,System.Boolean)">
<summary>
get suggested ganjoor links
</summary>
<param name="status"></param>
<param name="notSynced"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.ReviewSuggestedLink(System.Guid,System.Guid,RMuseum.Models.GanjoorIntegration.ReviewResult)">
<summary>
Review Suggested Link
</summary>
<param name="linkId"></param>
<param name="userId"></param>
<param name="result"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.AddTOCForSuggestedLinks">
<summary>
Temporary api
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.SynchronizeSuggestedLink(System.Guid)">
<summary>
Synchronize suggested link
</summary>
<param name="linkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.GetSuggestedPinterestLinks(RMuseum.Models.GanjoorIntegration.ReviewResult,System.Boolean)">
<summary>
get suggested pinterest links
</summary>
<param name="status"></param>
<param name="notSynced"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.SuggestPinterestLink(RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion)">
<summary>
suggest pinterest link
</summary>
<param name="suggestion"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.ReviewSuggestedPinterestLink(System.Guid,System.Guid,System.String,RMuseum.Models.GanjoorIntegration.ReviewResult,System.String,System.String)">
<summary>
Review Suggested Pinterest Link
</summary>
<param name="linkId"></param>
<param name="userId"></param>
<param name="altText"></param>
<param name="result"></param>
<param name="reviewDesc"></param>
<param name="imageUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.SynchronizeSuggestedPinterestLink(System.Guid)">
<summary>
Synchronize suggested pinterest link
</summary>
<param name="linkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IArtifactService.RemoveArtifactHavingNoNoteAndBookmarks(System.Guid,System.Boolean)">
<summary>
an incomplete prototype for removing artifacts
</summary>
<param name="artifactId"></param>
<param name="checkJobs"></param>
<returns></returns>
</member>
<member name="T:RMuseum.Services.IGanjoorService">
<summary>
Ganjoor Poems Content Privider Service
</summary>
</member>
<member name="M:RMuseum.Services.IGanjoorService.ImportLocalSQLiteDb">
<summary>
imports unimported poem data from a locally accessible ganjoor SqlLite database
</summary>
<returns></returns>
</member>
<member name="T:RMuseum.Services.Implementation.ArtifactService">
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
<summary>
IArtifactService implementation
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromHarvardDirectly(System.String,System.String,System.String)">
<summary>
import from http://www.qajarwomen.org
</summary>
<param name="hardvardResourceNumber">43117279</param>
<param name="friendlyUrl">atame</param>
<param name="srcUrl">http://www.qajarwomen.org/fa/items/1018A10.html</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromBritishLibrary(System.String,System.String)">
<summary>
from http://www.bl.uk
</summary>
<param name="resourceNumber">grenville_xli_f001r</param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromCambridge(System.String,System.String)">
<summary>
from http://cudl.lib.cam.ac.uk
</summary>
<param name="resourceNumber">MS-RAS-00258</param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromChesterBeatty(System.String,System.String)">
<summary>
import from https://viewer.cbl.ie
</summary>
<param name="resourceNumber">119</param>
<param name="friendlyUrl">golestan-baysonghori</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromHarvard(System.String,System.String)">
<summary>
from https://curiosity.lib.harvard.edu
</summary>
<param name="url">example: https://curiosity.lib.harvard.edu/islamic-heritage-project/catalog/40-990114893240203941</param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromHathiTrust(System.String,System.String)">
<summary>
from https://catalog.hathitrust.org
</summary>
<param name="resourceNumber">006814127</param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromTheLibraryOfCongress(System.String,System.String,System.String)">
<summary>
from https://www.loc.gov
</summary>
<param name="resourceNumber">
<example>
m084
</example>
</param>
<param name="friendlyUrl">
<example>
boostan1207
</example>
</param>
<param name="resourcePrefix"></param>
<example>
plmp
</example>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromPenLibraries(System.String,System.String)">
<summary>
from http://www.library.upenn.edu/
</summary>
<param name="resourceNumber">MEDREN_9949222153503681</param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromServerFolder(System.String,System.String,System.String)">
<summary>
import from server folder
</summary>
<param name="folderPath">C:\Tools\batches\florence</param>
<param name="friendlyUrl">shahname-florence</param>
<param name="srcUrl">https://t.me/dr_khatibi_abolfazl/888</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromWalters(System.String,System.String)">
<summary>
from http://www.thedigitalwalters.org/01_ACCESS_WALTERS_MANUSCRIPTS.html
</summary>
<param name="resourceNumber">W619</param>
<param name="friendlyUrl">golestan-walters-01</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.StartImportingFromPrinceton(System.String,System.String)">
<summary>
from http://pudl.princeton.edu/
</summary>
<param name="resourceNumber">dj52w476m</param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetAll(RSecurityBackend.Models.Generic.PagingParameterModel,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
get all artifacts (including CoverImage info but not items or tagibutes info)
</summary>
<param name="paging"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetByTagValue(System.String,System.String,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
get tagged publish artifacts (including CoverImage info but not items or tagibutes info)
</summary>
<param name="tagUrl"></param>
<param name="valueUrl"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetByFriendlyUrl(System.String,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
gets specified artifact info (including CoverImage + images + tagibutes)
</summary>
<param name="friendlyUrl"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetByFriendlyUrlFilterItemsByTag(System.String,RMuseum.Models.Artifact.PublishStatus[],System.String,System.String)">
<summary>
gets specified artifact info (including CoverImage + images + tagibutes)
</summary>
<param name="friendlyUrl"></param>
<param name="statusArray"></param>
<param name="tagFriendlyUrl"></param>
<param name="tagValueFriendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditMasterRecord(RMuseum.Models.Artifact.RArtifactMasterRecord,System.Boolean,System.Boolean)">
<summary>
edit master record
</summary>
<param name="edited"></param>
<param name="canChangeStatusToAwaiting"></param>
<param name="canPublish"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.SetArtifactCoverItemIndex(System.Guid,System.Int32)">
<summary>
Set Artifact Cover Item Index
</summary>
<param name="artifactId"></param>
<param name="itemIndex"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetTagBundleByFiendlyUrl(System.String)">
<summary>
get tag bundle by frindly url
</summary>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetMaxArtifactLastModified">
<summary>
get max lastmodified artifact date for caching purposes
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetAllTags(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
get all tags
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetTagByFriendlyUrl(System.String)">
<summary>
get tag bu friendly url
</summary>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetTagValueByFriendlyUrl(System.Guid,System.String)">
<summary>
get tag value by frindly url
</summary>
<param name="tagId"></param>
<param name="friendlyUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.AddTag(System.String)">
<summary>
add tag
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditTag(RMuseum.Models.Artifact.RTag)">
<summary>
edit tag
</summary>
<param name="edited"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.UpdateTaggedItems(RMuseum.Models.Artifact.RTag)">
<summary>
changes LastModified field value for tagged artifacts and items
</summary>
<param name="tag"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditTagOrderBasedOnArtifact(System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tags based on their position in artifacts
</summary>
<param name="tagId"></param>
<param name="artifactId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditTagOrderBasedOnItem(System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tags based on their position in artifact items
</summary>
<param name="tagId"></param>
<param name="itemId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetTagValueBundleByFiendlyUrl(System.String,System.String)">
<summary>
get tag value bundle by frindly url
</summary>
<param name="friendlyUrl"></param>
<param name="valueUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.TagArtifact(System.Guid,RMuseum.Models.Artifact.RTag)">
<summary>
add artifact tag value
</summary>
<param name="artifactId"></param>
<param name="rTag"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.UnTagArtifact(System.Guid,System.Guid)">
<summary>
remove artfiact tag value
</summary>
<param name="artifactId"></param>
<param name="tagValueId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditTagValue(System.Guid,RMuseum.Models.Artifact.RTagValue,System.Boolean)">
<summary>
edit artifact tag value
</summary>
<param name="artifactId"></param>
<param name="edited"></param>
<param name="global">apply on all same value tags</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.TagItem(System.Guid,RMuseum.Models.Artifact.RTag)">
<summary>
add item tag value
</summary>
<param name="itemId"></param>
<param name="rTag"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.UnTagItem(System.Guid,System.Guid)">
<summary>
remove item tag value
</summary>
<param name="itemId"></param>
<param name="tagValueId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditItemTagValue(System.Guid,RMuseum.Models.Artifact.RTagValue,System.Boolean)">
<summary>
edit item tagibute value
</summary>
<param name="itemtId"></param>
<param name="edited"></param>
<param name="global">apply on all same value tags</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditTagValueOrder(System.Guid,System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tag values based on their position in an artifact
</summary>
<param name="artifactId"></param>
<param name="tagId"></param>
<param name="valueId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag value which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditItemTagValueOrder(System.Guid,System.Guid,System.Guid,System.Boolean)">
<summary>
changes order of tag values based on their position in an item
</summary>
<param name="itemId"></param>
<param name="tagId"></param>
<param name="valueId"></param>
<param name="up">true => up, false => down</param>
<returns>the other tag value which its Order has been changed</returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetArtifactItemByFrienlyUrl(System.String,System.String,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
gets specified artifact item info (including images + tagibutes)
</summary>
<param name="artifactUrl"></param>
<param name="itemUrl"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.Add(System.String,System.String,System.String,System.String,System.String,Microsoft.AspNetCore.Http.IFormFile,System.String,System.IO.Stream)">
<summary>
add new artifact
</summary>
<param name="name"></param>
<param name="description"></param>
<param name="srcurl"></param>
<param name="pictitle"></param>
<param name="picdescription"></param>
<param name="file"></param>
<param name="picsrcurl"></param>
<param name="stream"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.Import(System.String,System.String,System.String,System.String)">
<summary>
import from external resources
</summary>
<param name="srcType">loc/princeton/harvard/qajarwomen/hathitrust/penn/cam/bl/folder/walters/cbl</param>
<param name="resourceNumber">119</param>
<param name="friendlyUrl">golestan-baysonghori</param>
<param name="resourcePrefix"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.RescheduleJobs">
<summary>
reschedule jobs
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.RemoveArtifactHavingNoNoteAndBookmarks(System.Guid,System.Boolean)">
<summary>
an incomplete prototype for removing artifacts
</summary>
<param name="artifactId"></param>
<param name="checkJobs"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.ReExamineLocDownloads">
<summary>
due to a bug in loc json outputs some artifacts with more than 1000 pages were downloaded incompletely
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetImportJobs(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
import jobs
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.BookmarkArtifact(System.Guid,System.Guid,RMuseum.Models.Bookmark.RBookmarkType)">
<summary>
Bookmark Artifact
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetArtifactUserBookmarks(System.Guid,System.Guid)">
<summary>
get artifact user bookmarks
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.BookmarkItem(System.Guid,System.Guid,RMuseum.Models.Bookmark.RBookmarkType)">
<summary>
Bookmark Item
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<param name="type"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GeItemUserBookmarks(System.Guid,System.Guid)">
<summary>
get item user bookmarks
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.UpdateUserBookmark(System.Guid,System.String)">
<summary>
update bookmark note
</summary>
<param name="bookmarkId"></param>
<param name="note"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.DeleteUserBookmark(System.Guid)">
<summary>
delete user bookmark
/// </summary>
<param name="bookmarkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetBookmarks(RSecurityBackend.Models.Generic.PagingParameterModel,System.Guid,RMuseum.Models.Bookmark.RBookmarkType,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
get user bookmarks (artifacts and items)
</summary>
<param name="paging"></param>
<param name="userId"></param>
<param name="type"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.AddUserNoteToArtifact(System.Guid,System.Guid,RMuseum.Models.Note.RNoteType,System.String,System.Nullable{System.Guid})">
<summary>
Add Note to Artifact
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<param name="type"></param>
<param name="noteContents"></param>
<param name="referenceNoteId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.AddUserNoteToArtifactItem(System.Guid,System.Guid,RMuseum.Models.Note.RNoteType,System.String,System.Nullable{System.Guid})">
<summary>
Add Note to Artifact Item
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<param name="type"></param>
<param name="noteContents"></param>
<param name="referenceNoteId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.EditUserNote(System.Guid,System.Nullable{System.Guid},System.String)">
<summary>
Edit Note
</summary>
<param name="noteId"></param>
<param name="userId"></param>
<param name="noteContents"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.DeleteUserNote(System.Guid,System.Nullable{System.Guid})">
<summary>
delete note
</summary>
<param name="noteId"></param>
<param name="userId">sending null here means user is a moderator or the note is being deleted in a recursive delete of referenced notes</param>
<returns>list of notes deleted</returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetArtifactUserNotes(System.Guid,System.Guid)">
<summary>
get artifact private user notes
</summary>
<param name="artifactId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService._GetArtifactPublicNotes(System.Guid,System.Nullable{System.Guid})">
<summary>
recursvie call to build notes tree
</summary>
<param name="artifactId"></param>
<param name="parentNoteId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetArtifactPublicNotes(System.Guid)">
<summary>
get artifact public user notes
</summary>
<param name="artifactId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetArtifactItemUserNotes(System.Guid,System.Guid)">
<summary>
get item artifact private user notes
</summary>
<param name="itemId"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService._GetArtifactItemPublicNotes(System.Guid,System.Nullable{System.Guid})">
<summary>
recursvie call to build notes tree for iten
</summary>
<param name="itemId"></param>
<param name="parentNoteId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetArtifactItemPublicNotes(System.Guid)">
<summary>
get item artifact item public user notes
</summary>
<param name="itemId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetUserNotes(System.Guid,RSecurityBackend.Models.Generic.PagingParameterModel,RMuseum.Models.Note.RNoteType,RMuseum.Models.Artifact.PublishStatus[])">
<summary>
Get All USer Notes
</summary>
<param name="userId"></param>
<param name="paging"></param>
<param name="type"></param>
<param name="statusArray"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetAllPublicNotes(RSecurityBackend.Models.Generic.PagingParameterModel)">
<summary>
Get All Public Notes
</summary>
<param name="paging"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.SuggestGanjoorLink(System.Guid,RMuseum.Models.GanjoorIntegration.ViewModels.LinkSuggestion)">
<summary>
suggest ganjoor link
</summary>
<param name="userId"></param>
<param name="link"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetSuggestedLinks(RMuseum.Models.GanjoorIntegration.ReviewResult,System.Boolean)">
<summary>
get suggested ganjoor links
</summary>
<param name="status"></param>
<param name="notSynced"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.ReviewSuggestedLink(System.Guid,System.Guid,RMuseum.Models.GanjoorIntegration.ReviewResult)">
<summary>
Review Suggested Link
</summary>
<param name="linkId"></param>
<param name="userId"></param>
<param name="result"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.AddTOCForSuggestedLinks">
<summary>
Temporary api
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.SynchronizeSuggestedLink(System.Guid)">
<summary>
Synchronize suggested link
</summary>
<param name="linkId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.GetSuggestedPinterestLinks(RMuseum.Models.GanjoorIntegration.ReviewResult,System.Boolean)">
<summary>
get suggested pinterest links
</summary>
<param name="status"></param>
<param name="notSynced"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.SuggestPinterestLink(RMuseum.Models.GanjoorIntegration.ViewModels.PinterestSuggestion)">
<summary>
suggest pinterest link
</summary>
<param name="suggestion"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.ReviewSuggestedPinterestLink(System.Guid,System.Guid,System.String,RMuseum.Models.GanjoorIntegration.ReviewResult,System.String,System.String)">
<summary>
Review Suggested Pinterest Link
</summary>
<param name="linkId"></param>
<param name="userId"></param>
<param name="altText"></param>
<param name="result"></param>
<param name="reviewDesc"></param>
<param name="imageUrl"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.SynchronizeSuggestedPinterestLink(System.Guid)">
<summary>
Synchronize suggested pinterest link
</summary>
<param name="linkId"></param>
<returns></returns>
</member>
<member name="F:RMuseum.Services.Implementation.ArtifactService._context">
<summary>
Database Contetxt
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.ArtifactService._pictureFileService">
<summary>
Picture File Service
</summary>
</member>
<member name="P:RMuseum.Services.Implementation.ArtifactService.Configuration">
<summary>
Configuration
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.ArtifactService._backgroundTaskQueue">
<summary>
Background Task Queue Instance
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.ArtifactService._userService">
<summary>
User Service
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.ArtifactService._notificationService">
<summary>
Messaging service
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.ArtifactService.#ctor(RMuseum.DbContext.RMuseumDbContext,Microsoft.Extensions.Configuration.IConfiguration,RMuseum.Services.IPictureFileService,RMuseum.Services.IBackgroundTaskQueue,RSecurityBackend.Services.IAppUserService,RMuseum.Services.IRNotificationService)">
<summary>
constructor
</summary>
<param name="context"></param>
<param name="configuration"></param>
<param name="pictureFileService"></param>
<param name="backgroundTaskQueue"></param>
<param name="userService"></param>
<param name="notificationService"></param>
</member>
<member name="T:RMuseum.Services.Implementation.BLTileMixer">
<summary>
British Library Tile Downloader And Mixer
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.BLTileMixer.#ctor">
<summary>
Constructor
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.BLTileMixer._GetEncoder(System.Drawing.Imaging.ImageFormat)">
<summary>
find image encodder
</summary>
<param name="format"></param>
<returns></returns>
</member>
<member name="T:RMuseum.Services.Implementation.GanjoorService">
<summary>
IGanjoorService implementation
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.GanjoorService.ImportLocalSQLiteDb">
<summary>
imports unimported poem data from a locally accessible ganjoor SqlLite database
</summary>
<returns></returns>
</member>
<member name="F:RMuseum.Services.Implementation.GanjoorService._context">
<summary>
Database Contetxt
</summary>
</member>
<member name="P:RMuseum.Services.Implementation.GanjoorService.Configuration">
<summary>
Configuration
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.GanjoorService.#ctor(RMuseum.DbContext.RMuseumDbContext,Microsoft.Extensions.Configuration.IConfiguration)">
<summary>
constructor
</summary>
<param name="context"></param>
<param name="configuration"></param>
</member>
<member name="T:RMuseum.Services.Implementation.ImportedFromDesktopGanjoor.GPersianTextSync">
<summary>
Persian specific text utility class
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.ImportedFromDesktopGanjoor.GPersianTextSync.Sync(System.String)">
<summary>
convert arabic characters to persian equivalents
</summary>
<param name="inputStr"></param>
<returns></returns>
</member>
<member name="P:RMuseum.Services.Implementation.ImportedFromDesktopGanjoor.GPersianTextSync.PersianLetters">
<summary>
list of persian letters
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.ImportedFromDesktopGanjoor.GPersianTextSync.Farglisize(System.String)">
<summary>
convert persian text to simple pinglish
</summary>
<param name="inputStr"></param>
<returns></returns>
</member>
<member name="F:RMuseum.Services.Implementation.ImportedFromDesktopGanjoor.GPersianTextSync._PinglishDic">
<summary>
equaivalnet for persian characters
</summary>
</member>
<member name="T:RMuseum.Services.Implementation.LanguageUtils">
<summary>
Language Utilitis
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.LanguageUtils.PersianAlphabet">
<summary>
Persian Alphabet
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.LanguageUtils.EnglishLowerCaseAlphabet">
<summary>
English Alphabet
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.LanguageUtils.GetFirstNotMatchingCharacter(System.String,System.String,System.String)">
<summary>
Check to see if input Contains Only Specific Characters
</summary>
<param name="input"></param>
<param name="specfics"></param>
<param name="additional"></param>
<returns></returns>
</member>
<member name="T:RMuseum.Services.Implementation.PictureFileService">
<summary>
manipulating picture files
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.RecoverFromeFiles(System.String,System.String,System.Int32,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
recover from files
</summary>
<param name="title"></param>
<param name="description"></param>
<param name="order"></param>
<param name="srcurl"></param>
<param name="orignalFilePath"></param>
<param name="normalFilePath"></param>
<param name="thumbFilePath"></param>
<param name="originalFileNameForStreams"></param>
<param name="imageFolderName"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.Add(System.String,System.String,System.Int32,Microsoft.AspNetCore.Http.IFormFile,System.String,System.IO.Stream,System.String,System.String)">
<summary>
add new picture
</summary>
<param name="title"></param>
<param name="description"></param>
<param name="order"></param>
<param name="file"></param>
<param name="srcurl"></param>
<param name="stream"></param>
<param name="originalFileNameForStreams"></param>
<param name="imageFolderName">pass empty if you want a generic date based folder</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.GetImage(System.Guid)">
<summary>
returns image info
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.RotateImage(System.Guid,System.Int32)">
<summary>
Rotate Image in 90 deg. multiplicants: 90, 180 or 270
</summary>
<param name="id"></param>
<param name="degIn90mul"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.GetEncoder(System.Drawing.Imaging.ImageFormat)">
<summary>
find image encodder
</summary>
<param name="format"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.GetImagePath(RMuseum.Models.Artifact.RPictureFile,System.String)">
<summary>
returns image file stream
</summary>
<param name="image"></param>
<param name="sz"></param>
<returns></returns>
</member>
<member name="P:RMuseum.Services.Implementation.PictureFileService.ResizedImageContentType">
<summary>
فرمت تصاویر بندانگشتی و ...
</summary>
<example>image/jpeg</example>
</member>
<member name="P:RMuseum.Services.Implementation.PictureFileService.NormalImageMaxWidth">
<summary>
عرض تصویر با اندازه نرمال - جهت نمایش در صفحات
</summary>
</member>
<member name="P:RMuseum.Services.Implementation.PictureFileService.NormalImageMaxHeight">
<summary>
/// طول تصویر با اندازه نرمال - جهت نمایش در صفحات
</summary>
</member>
<member name="P:RMuseum.Services.Implementation.PictureFileService.ThumbnailImageWidth">
<summary>
عرض تصویر بندانگشتی
</summary>
</member>
<member name="P:RMuseum.Services.Implementation.PictureFileService.ThumbnailImageMaxHeight">
<summary>
طول تصویر بندانگشتی
</summary>
</member>
<member name="P:RMuseum.Services.Implementation.PictureFileService.ImageStoragePath">
<summary>
Image Storage Path
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.GenerateCroppedImageBasedOnThumbnailCoordinates(System.Guid,System.Decimal,System.Decimal,System.Decimal,System.Decimal)">
<summary>
Generated Cropped Image Based On ThumbnailCoordinates For Notes
</summary>
<param name="id"></param>
<param name="left"></param>
<param name="top"></param>
<param name="width"></param>
<param name="height"></param>
<returns></returns>
</member>
<member name="F:RMuseum.Services.Implementation.PictureFileService._context">
<summary>
Database Contetxt
</summary>
</member>
<member name="P:RMuseum.Services.Implementation.PictureFileService.Configuration">
<summary>
Configuration
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.PictureFileService._simpleImageStorage">
<summary>
Simple Image Storage (not storing multiple image sizes) for creating small cropped images
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.PictureFileService.#ctor(RMuseum.DbContext.RMuseumDbContext,Microsoft.Extensions.Configuration.IConfiguration,RSecurityBackend.Services.IImageFileService)">
<summary>
constructor
</summary>
<param name="context"></param>
<param name="configuration"></param>
<param name="simpleImageStorage"></param>
</member>
<member name="T:RMuseum.Services.Implementation.RecitationService">
<summary>
Audio Narration Service Implementation
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetAll(RSecurityBackend.Models.Generic.PagingParameterModel,System.Guid,RMuseum.Models.GanjoorAudio.AudioReviewStatus)">
<summary>
returns list of narrations
</summary>
<param name="paging"></param>
<param name="filteredUserId">send Guid.Empty if you want all narrations</param>
<param name="status"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.Get(System.Int32)">
<summary>
return selected narration information
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.Delete(System.Int32,System.Guid)">
<summary>
Delete recitation
</summary>
<param name="id"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetPoemNarrationVerseSyncArray(System.Int32)">
<summary>
Gets Verse Sync Range Information
</summary>
<param name="id">narration id</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetPoemNarrationValidationError(RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel)">
<summary>
validate PoemNarrationViewModel
</summary>
<param name="p"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.UpdatePoemNarration(System.Int32,RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel)">
<summary>
updates metadata for narration
</summary>
<param name="id"></param>
<param name="metadata"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.OneTimeImport(System.Guid)">
<summary>
imports data from ganjoor MySql database
</summary>
<param name="ownerRAppUserId">User Id which becomes owner of imported data</param>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.BuildProfilesFromExistingData(System.Guid)">
<summary>
build profiles from exisng narrations data
</summary>
<param name="ownerRAppUserId">User Id which becomes owner of imported data</param>
<returns>error string if occurs</returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.InitiateNewUploadSession(System.Guid,System.Boolean)">
<summary>
Initiate New Upload Session for audio
</summary>
<param name="userId"></param>
<param name="replace"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.SaveUploadedFile(Microsoft.AspNetCore.Http.IFormFile)">
<summary>
Save uploaded file
</summary>
<param name="uploadedFile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.FinalizeNewUploadSession(RMuseum.Models.UploadSession.UploadSession,RMuseum.Models.UploadSession.UploadSessionFile[])">
<summary>
finalize upload session (add files)
</summary>
<param name="session"></param>
<param name="files"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.ModeratePoemNarration(System.Int32,System.Guid,RMuseum.Models.GanjoorAudio.ViewModels.RecitationModerateViewModel)">
<summary>
Moderate pending narration
</summary>
<param name="id"></param>
<param name="moderatorId"></param>
<param name="model"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.RetryPublish">
<summary>
retry publish unpublished narrations
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetUploadSession(System.Guid)">
<summary>
Get Upload Session (including files)
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetUserNarrationProfiles(System.Guid)">
<summary>
Get User Profiles
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetUserDefProfile(System.Guid)">
<summary>
Get User Default Profile
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetUserProfileValidationError(RMuseum.Models.GanjoorAudio.UserRecitationProfile)">
<summary>
validating narration profile
</summary>
<param name="p"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.AddUserNarrationProfiles(RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel)">
<summary>
Add a narration profile
</summary>
<param name="profile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.UpdateUserNarrationProfiles(RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel)">
<summary>
Update a narration profile
</summary>
<param name="profile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.DeleteUserNarrationProfiles(System.Guid,System.Guid)">
<summary>
Delete a narration profile
</summary>
<param name="id"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetUploads(RSecurityBackend.Models.Generic.PagingParameterModel,System.Guid)">
<summary>
Get uploads descending by upload time
</summary>
<param name="paging"></param>
<param name="userId">if userId is empty all user uploads would be returned</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.GetPublishingQueueStatus(RSecurityBackend.Models.Generic.PagingParameterModel,System.Boolean,System.Boolean)">
<summary>
publishing tracker data
</summary>
<param name="paging"></param>
<param name="inProgress"></param>
<param name="finished"></param>
<returns></returns>
</member>
<member name="P:RMuseum.Services.Implementation.RecitationService.Configuration">
<summary>
Configuration
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.RecitationService._context">
<summary>
Database Contetxt
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.RecitationService._backgroundTaskQueue">
<summary>
Background Task Queue Instance
</summary>
</member>
<member name="F:RMuseum.Services.Implementation.RecitationService._notificationService">
<summary>
Messaging service
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.RecitationService.#ctor(RMuseum.DbContext.RMuseumDbContext,Microsoft.Extensions.Configuration.IConfiguration,RMuseum.Services.IBackgroundTaskQueue,RMuseum.Services.IRNotificationService)">
<summary>
constructor
</summary>
<param name="context"></param>
<param name="configuration"></param>
<param name="backgroundTaskQueue"></param>
<param name="notificationService"></param>
</member>
<member name="T:RMuseum.Services.Implementation.RNotificationService">
<summary>
Internal messaging system implementation
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.RNotificationService.PushNotification(System.Guid,System.String,System.String)">
<summary>
Add Notification
</summary>
<param name="userId"></param>
<param name="subject"></param>
<param name="htmlText"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RNotificationService.SwitchNotificationStatus(System.Guid)">
<summary>
Switch Notification Status
</summary>
<param name="notificationId"></param>
<returns>updated notification object</returns>
</member>
<member name="M:RMuseum.Services.Implementation.RNotificationService.DeleteNotification(System.Guid)">
<summary>
Delete Notification
</summary>
<param name="notificationId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RNotificationService.GetUserNotifications(System.Guid)">
<summary>
Get User Notifications
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RNotificationService.GetUnreadUserNotificationsCount(System.Guid)">
<summary>
Get Unread User Notifications Count
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="F:RMuseum.Services.Implementation.RNotificationService._context">
<summary>
Database Contetxt
</summary>
</member>
<member name="T:RMuseum.Services.Implementation.RoleService">
<summary>
Role Service Implementation
</summary>
</member>
<member name="M:RMuseum.Services.Implementation.RoleService.GetSecurableItems">
<summary>
gets list of SecurableItem, should be reimplemented in end user applications
</summary>
<returns></returns>
</member>
<member name="M:RMuseum.Services.Implementation.RoleService.#ctor(Microsoft.AspNetCore.Identity.RoleManager{RSecurityBackend.Models.Auth.Db.RAppRole})">
<summary>
constructor
</summary>
<param name="roleManager"></param>
</member>
<member name="T:RMuseum.Services.IPictureFileService">
<summary>
manipulating picture files
</summary>
</member>
<member name="M:RMuseum.Services.IPictureFileService.Add(System.String,System.String,System.Int32,Microsoft.AspNetCore.Http.IFormFile,System.String,System.IO.Stream,System.String,System.String)">
<summary>
add new picture
</summary>
<param name="title"></param>
<param name="description"></param>
<param name="order"></param>
<param name="file"></param>
<param name="srcurl"></param>
<param name="stream"></param>
<param name="originalFileNameForStreams"></param>
<param name="imageFolderName">pass empty if you want a generic date based folder</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IPictureFileService.RecoverFromeFiles(System.String,System.String,System.Int32,System.String,System.String,System.String,System.String,System.String,System.String)">
<summary>
recover from files
</summary>
<param name="title"></param>
<param name="description"></param>
<param name="order"></param>
<param name="srcurl"></param>
<param name="orignalFilePath"></param>
<param name="normalFilePath"></param>
<param name="thumbFilePath"></param>
<param name="originalFileNameForStreams"></param>
<param name="imageFolderName"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IPictureFileService.GetImage(System.Guid)">
<summary>
returns image info
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IPictureFileService.GetImagePath(RMuseum.Models.Artifact.RPictureFile,System.String)">
<summary>
returns image file stream
</summary>
<param name="image"></param>
<param name="sz"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IPictureFileService.RotateImage(System.Guid,System.Int32)">
<summary>
Rotate Image in 90 deg. multiplicants: 90, 180 or 270
</summary>
<param name="id"></param>
<param name="degIn90mul"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IPictureFileService.GetEncoder(System.Drawing.Imaging.ImageFormat)">
<summary>
Get Encoder
</summary>
<param name="format"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IPictureFileService.GenerateCroppedImageBasedOnThumbnailCoordinates(System.Guid,System.Decimal,System.Decimal,System.Decimal,System.Decimal)">
<summary>
Generate Cropped Image Based On ThumbnailCoordinates For Notes
</summary>
<param name="id"></param>
<param name="left"></param>
<param name="top"></param>
<param name="width"></param>
<param name="height"></param>
<returns></returns>
</member>
<member name="P:RMuseum.Services.IPictureFileService.ImageStoragePath">
<summary>
Image Storage Path
</summary>
</member>
<member name="T:RMuseum.Services.IRecitationService">
<summary>
Audio Narration Service
</summary>
</member>
<member name="M:RMuseum.Services.IRecitationService.GetAll(RSecurityBackend.Models.Generic.PagingParameterModel,System.Guid,RMuseum.Models.GanjoorAudio.AudioReviewStatus)">
<summary>
returns list of narrations
</summary>
<param name="paging"></param>
<param name="filteredUserId">send Guid.Empty if you want all narrations</param>
<param name="status"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.Get(System.Int32)">
<summary>
return selected narration information
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.Delete(System.Int32,System.Guid)">
<summary>
Delete recitation (recitation should belong to userId)
</summary>
<param name="id"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.GetPoemNarrationVerseSyncArray(System.Int32)">
<summary>
Gets Verse Sync Range Information
</summary>
<param name="id">narration id</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.UpdatePoemNarration(System.Int32,RMuseum.Models.GanjoorAudio.ViewModels.RecitationViewModel)">
<summary>
updates metadata for narration
</summary>
<param name="id"></param>
<param name="metadata"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.OneTimeImport(System.Guid)">
<summary>
imports narration data from ganjoor MySql database
</summary>
<param name="ownerRAppUserId">User Id which becomes owner of imported data</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.BuildProfilesFromExistingData(System.Guid)">
<summary>
build profiles from exisng narrations data
</summary>
<param name="ownerRAppUserId">User Id which becomes owner of imported data</param>
<returns>error string if occurs</returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.InitiateNewUploadSession(System.Guid,System.Boolean)">
<summary>
Initiate New Upload Session for audio
</summary>
<param name="userId"></param>
<param name="replace"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.SaveUploadedFile(Microsoft.AspNetCore.Http.IFormFile)">
<summary>
Save uploaded file
</summary>
<param name="uploadedFile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.FinalizeNewUploadSession(RMuseum.Models.UploadSession.UploadSession,RMuseum.Models.UploadSession.UploadSessionFile[])">
<summary>
finalize upload session (add files)
</summary>
<param name="session"></param>
<param name="files"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.ModeratePoemNarration(System.Int32,System.Guid,RMuseum.Models.GanjoorAudio.ViewModels.RecitationModerateViewModel)">
<summary>
Moderate pending narration
</summary>
<param name="id"></param>
<param name="moderatorId"></param>
<param name="model"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.GetUploadSession(System.Guid)">
<summary>
Get Upload Session (including files)
</summary>
<param name="id"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.GetUserNarrationProfiles(System.Guid)">
<summary>
Get User Profiles
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.GetUserDefProfile(System.Guid)">
<summary>
Get User Default Profile
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.AddUserNarrationProfiles(RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel)">
<summary>
Add a narration profile
</summary>
<param name="profile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.UpdateUserNarrationProfiles(RMuseum.Models.GanjoorAudio.ViewModels.UserRecitationProfileViewModel)">
<summary>
Update a narration profile
</summary>
<param name="profile"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.DeleteUserNarrationProfiles(System.Guid,System.Guid)">
<summary>
Delete a narration profile
</summary>
<param name="id"></param>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.GetUploads(RSecurityBackend.Models.Generic.PagingParameterModel,System.Guid)">
<summary>
Get uploads descending by upload time
</summary>
<param name="paging"></param>
<param name="userId">if userId is empty all user uploads would be returned</param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRecitationService.RetryPublish">
<summary>
retry publish unpublished narrations
</summary>
</member>
<member name="M:RMuseum.Services.IRecitationService.GetPublishingQueueStatus(RSecurityBackend.Models.Generic.PagingParameterModel,System.Boolean,System.Boolean)">
<summary>
publishing tracker data
</summary>
<param name="paging"></param>
<param name="inProgress"></param>
<param name="finished"></param>
<returns></returns>
</member>
<member name="T:RMuseum.Services.IRNotificationService">
<summary>
Internal messaging system interface
</summary>
</member>
<member name="M:RMuseum.Services.IRNotificationService.PushNotification(System.Guid,System.String,System.String)">
<summary>
Add Notification
</summary>
<param name="userId"></param>
<param name="subject"></param>
<param name="htmlText"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRNotificationService.GetUserNotifications(System.Guid)">
<summary>
Get User Notifications
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRNotificationService.GetUnreadUserNotificationsCount(System.Guid)">
<summary>
Get Unread User Notifications Count
</summary>
<param name="userId"></param>
<returns></returns>
</member>
<member name="M:RMuseum.Services.IRNotificationService.SwitchNotificationStatus(System.Guid)">
<summary>
Switch Notification Status
</summary>
<param name="notificationId"></param>
<returns>updated notification object</returns>
</member>
<member name="M:RMuseum.Services.IRNotificationService.DeleteNotification(System.Guid)">
<summary>
Delete Notification
</summary>
<param name="notificationId"></param>
<returns></returns>
</member>
<member name="T:RMuseum.Swashbuckle.SecurityRequirementsOperationFilter">
<summary>
//https://mattfrear.com/2018/07/21/add-an-authorization-header-to-your-swagger-ui-with-swashbuckle-revisited/
</summary>
</member>
<member name="M:RMuseum.Swashbuckle.SecurityRequirementsOperationFilter.Apply(Microsoft.OpenApi.Models.OpenApiOperation,Swashbuckle.AspNetCore.SwaggerGen.OperationFilterContext)">
<summary>
</summary>
<param name="operation"></param>
<param name="context"></param>
</member>
<member name="T:ganjoor.PoemAudio">
<summary>
اطلاعات فایل صوتی شعر
</summary>
</member>
<member name="M:ganjoor.PoemAudio.#ctor">
<summary>
سازنده
</summary>
</member>
<member name="P:ganjoor.PoemAudio.PoemId">
<summary>
شناسۀ شعر
</summary>
</member>
<member name="P:ganjoor.PoemAudio.Id">
<summary>
شناسۀ فایل صوتی با شروع از 1 برای هر شعر
</summary>
</member>
<member name="P:ganjoor.PoemAudio.FilePath">
<summary>
مسیر فایل
</summary>
</member>
<member name="P:ganjoor.PoemAudio.Description">
<summary>
شرح
</summary>
</member>
<member name="P:ganjoor.PoemAudio.IsSynced">
<summary>
آیا همگام شده
</summary>
</member>
<member name="T:ganjoor.PoemAudio.SyncInfo">
<summary>
ساختار اطلاعات همگام سازی
</summary>
</member>
<member name="F:ganjoor.PoemAudio.SyncInfo.VerseOrder">
<summary>
ترتیب مصرع (-1 نشانگر آغاز فایل صوتی و -2 نشانگر پایان آن است)
</summary>
</member>
<member name="F:ganjoor.PoemAudio.SyncInfo.AudioMiliseconds">
<summary>
زمان در فایل صوتی بر حسب میلی ثانیه
</summary>
</member>
<member name="P:ganjoor.PoemAudio.SyncArray">
<summary>
اطلاعات همگام سازی
</summary>
</member>
<member name="P:ganjoor.PoemAudio.DownloadUrl">
<summary>
نشانی دریافت فایل صوتی
</summary>
</member>
<member name="P:ganjoor.PoemAudio.IsDirectlyDownloadable">
<summary>
آیا لینک دریافت فایل صوتی مستقیم است
</summary>
</member>
<member name="P:ganjoor.PoemAudio.SyncGuid">
<summary>
شناسۀ یکتای اطلاعات همگام سازی
</summary>
</member>
<member name="P:ganjoor.PoemAudio.FileCheckSum">
<summary>
امضای یکتای فایل صوتی
</summary>
</member>
<member name="M:ganjoor.PoemAudio.ComputeCheckSum(System.String)">
<summary>
محاسبه چک سام فایل
</summary>
<param name="filePath"></param>
</member>
<member name="P:ganjoor.PoemAudio.IsUploaded">
<summary>
آیا اطلاعات همگام سازی آپلود شده؟
</summary>
</member>
<member name="M:ganjoor.PoemAudio.ToString">
<summary>
تبدیل به رشته
</summary>
<returns>شرح</returns>
</member>
<member name="P:ganjoor.PoemAudio.PoetName">
<remarks>
Warning: not always filled
</remarks>
</member>
<member name="P:ganjoor.PoemAudio.PoemTitle">
<remarks>
Warning: Rarely filled
</remarks>
</member>
<member name="T:ganjoor.PoemAudioListProcessor">
<summary>
پردازشگر ذخیره و بارگذاری لیستهای اشعار
</summary>
</member>
<member name="M:ganjoor.PoemAudioListProcessor.Save(System.String,ganjoor.PoemAudio,System.Boolean)">
<summary>
ذخیره در فایل
</summary>
<param name="FileName"></param>
<param name="poemAudio"></param>
<param name="oldVersion"></param>
<returns></returns>
</member>
<member name="M:ganjoor.PoemAudioListProcessor.Save(System.String,System.Collections.Generic.List{ganjoor.PoemAudio},System.Boolean)">
<summary>
ذخیره در فایل
</summary>
<param name="FileName"></param>
<param name="List"></param>
<param name="oldVersion"></param>
<returns></returns>
</member>
<member name="M:ganjoor.PoemAudioListProcessor.Load(System.String)">
<summary>
بارگذاری از فایل
</summary>
<param name="FileName"></param>
<returns></returns>
</member>
</members>
</doc>
Reference in New Issue View Git Blame Copy Permalink