{ "name": "Volo.Docs.Domain", "hash": "", "contents": [ { "namespace": "Volo.Docs", "dependsOnModules": [ { "declaringAssemblyName": "Volo.Docs.Domain.Shared", "namespace": "Volo.Docs", "name": "DocsDomainSharedModule" }, { "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "namespace": "Volo.Abp.Domain", "name": "AbpDddDomainModule" }, { "declaringAssemblyName": "Volo.Abp.Mapperly", "namespace": "Volo.Abp.Mapperly", "name": "AbpMapperlyModule" }, { "declaringAssemblyName": "Volo.Abp.BlobStoring", "namespace": "Volo.Abp.BlobStoring", "name": "AbpBlobStoringModule" }, { "declaringAssemblyName": "Volo.Abp.Caching", "namespace": "Volo.Abp.Caching", "name": "AbpCachingModule" } ], "implementingInterfaces": [ { "name": "IAbpModule", "namespace": "Volo.Abp.Modularity", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.Modularity.IAbpModule" }, { "name": "IOnPreApplicationInitialization", "namespace": "Volo.Abp.Modularity", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.Modularity.IOnPreApplicationInitialization" }, { "name": "IOnApplicationInitialization", "namespace": "Volo.Abp", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.IOnApplicationInitialization" }, { "name": "IOnPostApplicationInitialization", "namespace": "Volo.Abp.Modularity", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.Modularity.IOnPostApplicationInitialization" }, { "name": "IOnApplicationShutdown", "namespace": "Volo.Abp", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.IOnApplicationShutdown" }, { "name": "IPreConfigureServices", "namespace": "Volo.Abp.Modularity", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.Modularity.IPreConfigureServices" }, { "name": "IPostConfigureServices", "namespace": "Volo.Abp.Modularity", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.Modularity.IPostConfigureServices" } ], "contentType": "abpModule", "name": "DocsDomainModule", "summary": null }, { "namespace": "Volo.Docs.Projects", "primaryKeyType": null, "properties": [ { "type": "System.Guid", "name": "ProjectId", "summary": null }, { "type": "System.String", "name": "FileName", "summary": null }, { "type": "System.String", "name": "Version", "summary": null }, { "type": "System.String", "name": "LanguageCode", "summary": null }, { "type": "System.DateTime", "name": "CreationTime", "summary": null }, { "type": "System.Nullable`1[System.DateTime]", "name": "LastModificationTime", "summary": null } ], "contentType": "entity", "name": "ProjectPdfFile", "summary": null }, { "namespace": "Volo.Docs.Documents", "primaryKeyType": null, "properties": [ { "type": "System.Guid", "name": "DocumentId", "summary": null }, { "type": "System.String", "name": "Username", "summary": null }, { "type": "System.Int32", "name": "CommitCount", "summary": null }, { "type": "System.String", "name": "UserProfileUrl", "summary": null }, { "type": "System.String", "name": "AvatarUrl", "summary": null } ], "contentType": "entity", "name": "DocumentContributor", "summary": null }, { "baseClass": { "name": "AggregateRoot", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.AggregateRoot" }, "implementingInterfaces": [ { "name": "IEntity", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IEntity" }, { "name": "IKeyedObject", "namespace": "Volo.Abp", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.IKeyedObject" }, { "name": "IEntity", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IEntity" }, { "name": "IAggregateRoot", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IAggregateRoot" }, { "name": "IAggregateRoot", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IAggregateRoot" }, { "name": "IGeneratesDomainEvents", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IGeneratesDomainEvents" }, { "name": "IHasExtraProperties", "namespace": "Volo.Abp.Data", "declaringAssemblyName": "Volo.Abp.ObjectExtending", "fullName": "Volo.Abp.Data.IHasExtraProperties" }, { "name": "IHasConcurrencyStamp", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Data", "fullName": "Volo.Abp.Domain.Entities.IHasConcurrencyStamp" } ], "methods": [ { "returnType": "Void", "namespace": "Volo.Docs.Projects", "name": "SetName", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "name", "isOptional": false } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Projects", "name": "SetFormat", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "format", "isOptional": false } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Projects", "name": "SetNavigationDocumentName", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "navigationDocumentName", "isOptional": false } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Projects", "name": "SetParametersDocumentName", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "parametersDocumentName", "isOptional": false } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Projects", "name": "SetDefaultDocumentName", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "defaultDocumentName", "isOptional": false } ] }, { "returnType": "ProjectPdfFile", "namespace": "Volo.Docs.Projects", "name": "FindPdfFile", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "fileName", "isOptional": false } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Projects", "name": "AddPdfFile", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "String", "name": "fileName", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Projects", "name": "RemovePdfFile", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "fileName", "isOptional": false } ] }, { "returnType": "String", "namespace": "Volo.Docs.Projects", "name": "GetFullVersion", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "version", "isOptional": false } ] } ], "collectionProperties": { "pdfFiles": { "name": "ProjectPdfFile", "namespace": "Volo.Docs.Projects", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Projects.ProjectPdfFile" } }, "navigationProperties": {}, "namespace": "Volo.Docs.Projects", "primaryKeyType": "Guid", "properties": [ { "type": "System.String", "name": "Name", "summary": "Name of the project for display purposes." }, { "type": "System.String", "name": "ShortName", "summary": "A short name of the project to be seen in URLs." }, { "type": "System.String", "name": "Format", "summary": "The format of the document (e.g. \"md\" for Markdown, \"html\" for HTML)." }, { "type": "System.String", "name": "DefaultDocumentName", "summary": "The document for the initial page." }, { "type": "System.String", "name": "NavigationDocumentName", "summary": "The document to be used for the navigation menu (index)." }, { "type": "System.String", "name": "ParametersDocumentName", "summary": "The document to be used for the parameters file (index)." }, { "type": "System.String", "name": "MinimumVersion", "summary": null }, { "type": "System.String", "name": "DocumentStoreType", "summary": "The source of the documents (e.g. Github)." }, { "type": "System.String", "name": "MainWebsiteUrl", "summary": null }, { "type": "System.String", "name": "LatestVersionBranchName", "summary": null }, { "type": "System.Collections.Generic.List`1[Volo.Docs.Projects.ProjectPdfFile]", "name": "PdfFiles", "summary": null } ], "contentType": "aggregateRoot", "name": "Project", "summary": null }, { "baseClass": { "name": "AggregateRoot", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.AggregateRoot" }, "implementingInterfaces": [ { "name": "IEntity", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IEntity" }, { "name": "IKeyedObject", "namespace": "Volo.Abp", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.IKeyedObject" }, { "name": "IEntity", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IEntity" }, { "name": "IAggregateRoot", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IAggregateRoot" }, { "name": "IAggregateRoot", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IAggregateRoot" }, { "name": "IGeneratesDomainEvents", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.IGeneratesDomainEvents" }, { "name": "IHasExtraProperties", "namespace": "Volo.Abp.Data", "declaringAssemblyName": "Volo.Abp.ObjectExtending", "fullName": "Volo.Abp.Data.IHasExtraProperties" }, { "name": "IHasConcurrencyStamp", "namespace": "Volo.Abp.Domain.Entities", "declaringAssemblyName": "Volo.Abp.Data", "fullName": "Volo.Abp.Domain.Entities.IHasConcurrencyStamp" } ], "methods": [ { "returnType": "Void", "namespace": "Volo.Docs.Documents", "name": "AddContributor", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "username", "isOptional": false }, { "type": "String", "name": "userProfileUrl", "isOptional": false }, { "type": "String", "name": "avatarUrl", "isOptional": false }, { "type": "Int32", "name": "commitCount", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents", "name": "RemoveAllContributors", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents", "name": "RemoveContributor", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "username", "isOptional": false }, { "type": "String", "name": "userProfileUrl", "isOptional": false }, { "type": "String", "name": "avatarUrl", "isOptional": false } ] }, { "returnType": "DocumentContributor", "namespace": "Volo.Docs.Documents", "name": "FindContributor", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "username", "isOptional": false }, { "type": "String", "name": "userProfileUrl", "isOptional": false }, { "type": "String", "name": "avatarUrl", "isOptional": false } ] } ], "collectionProperties": { "contributors": { "name": "DocumentContributor", "namespace": "Volo.Docs.Documents", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Documents.DocumentContributor" } }, "navigationProperties": {}, "namespace": "Volo.Docs.Documents", "primaryKeyType": "Guid", "properties": [ { "type": "System.Guid", "name": "ProjectId", "summary": null }, { "type": "System.String", "name": "Name", "summary": null }, { "type": "System.String", "name": "Version", "summary": null }, { "type": "System.String", "name": "LanguageCode", "summary": null }, { "type": "System.String", "name": "FileName", "summary": null }, { "type": "System.String", "name": "Content", "summary": null }, { "type": "System.String", "name": "Format", "summary": null }, { "type": "System.String", "name": "EditLink", "summary": null }, { "type": "System.String", "name": "RootUrl", "summary": null }, { "type": "System.String", "name": "RawRootUrl", "summary": null }, { "type": "System.String", "name": "LocalDirectory", "summary": null }, { "type": "System.DateTime", "name": "CreationTime", "summary": null }, { "type": "System.DateTime", "name": "LastUpdatedTime", "summary": null }, { "type": "System.Nullable`1[System.DateTime]", "name": "LastSignificantUpdateTime", "summary": null }, { "type": "System.DateTime", "name": "LastCachedTime", "summary": null }, { "type": "System.Collections.Generic.List`1[Volo.Docs.Documents.DocumentContributor]", "name": "Contributors", "summary": null } ], "contentType": "aggregateRoot", "name": "Document", "summary": null }, { "namespace": "Volo.Docs.GitHub.Documents", "baseClass": { "name": "DomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.DomainService" }, "methods": [ { "returnType": "Document", "namespace": "Volo.Docs.GitHub.Documents", "name": "GetDocumentAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false }, { "type": "String", "name": "documentName", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "Nullable", "name": "lastKnownSignificantUpdateTime", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.GitHub.Documents", "name": "GetVersionsAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false } ] }, { "returnType": "DocumentResource", "namespace": "Volo.Docs.GitHub.Documents", "name": "GetResource", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false }, { "type": "String", "name": "resourceName", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false } ] }, { "returnType": "LanguageConfig", "namespace": "Volo.Docs.GitHub.Documents", "name": "GetLanguageListAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false } ] } ], "implementingInterfaces": [ { "name": "IDomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.IDomainService" }, { "name": "ITransientDependency", "namespace": "Volo.Abp.DependencyInjection", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.DependencyInjection.ITransientDependency" }, { "name": "IDocumentSource", "namespace": "Volo.Docs.Documents", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Documents.IDocumentSource" } ], "contentType": "domainService", "name": "GithubDocumentSource", "summary": null }, { "namespace": "Volo.Docs.GitHub.Documents", "baseClass": { "name": "DomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.DomainService" }, "methods": [ { "returnType": "Boolean", "namespace": "Volo.Docs.GitHub.Documents", "name": "HasPatchSignificantChanges", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "patch", "isOptional": false } ] } ], "implementingInterfaces": [ { "name": "IDomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.IDomainService" }, { "name": "ITransientDependency", "namespace": "Volo.Abp.DependencyInjection", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.DependencyInjection.ITransientDependency" }, { "name": "IGithubPatchAnalyzer", "namespace": "Volo.Docs.GitHub.Documents", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.GitHub.Documents.IGithubPatchAnalyzer" } ], "contentType": "domainService", "name": "GithubPatchAnalyzer", "summary": null }, { "namespace": "Volo.Docs.FileSystem.Documents", "baseClass": { "name": "DomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.DomainService" }, "methods": [ { "returnType": "Document", "namespace": "Volo.Docs.FileSystem.Documents", "name": "GetDocumentAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false }, { "type": "String", "name": "documentName", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "Nullable", "name": "lastKnownSignificantUpdateTime", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.FileSystem.Documents", "name": "GetVersionsAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false } ] }, { "returnType": "LanguageConfig", "namespace": "Volo.Docs.FileSystem.Documents", "name": "GetLanguageListAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false } ] }, { "returnType": "DocumentResource", "namespace": "Volo.Docs.FileSystem.Documents", "name": "GetResource", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Project", "name": "project", "isOptional": false }, { "type": "String", "name": "resourceName", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false } ] } ], "implementingInterfaces": [ { "name": "IDomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.IDomainService" }, { "name": "ITransientDependency", "namespace": "Volo.Abp.DependencyInjection", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.DependencyInjection.ITransientDependency" }, { "name": "IDocumentSource", "namespace": "Volo.Docs.Documents", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Documents.IDocumentSource" } ], "contentType": "domainService", "name": "FileSystemDocumentSource", "summary": null }, { "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "baseClass": { "name": "DomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.DomainService" }, "methods": [ { "returnType": "Void", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "CreateIndexIfNeededAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "AddOrUpdateAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Document", "name": "document", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "AddOrUpdateManyAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "IEnumerable", "name": "documents", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "DeleteAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "id", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "DeleteAllAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "DeleteAllByProjectIdAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "EsDocumentResult", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "SearchAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "context", "isOptional": false }, { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "Nullable", "name": "skipCount", "isOptional": true }, { "type": "Nullable", "name": "maxResultCount", "isOptional": true }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "name": "ValidateElasticSearchEnabled", "summary": null, "isAsync": false, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [] } ], "implementingInterfaces": [ { "name": "IDomainService", "namespace": "Volo.Abp.Domain.Services", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Services.IDomainService" }, { "name": "ITransientDependency", "namespace": "Volo.Abp.DependencyInjection", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.DependencyInjection.ITransientDependency" }, { "name": "IDocumentFullSearch", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Documents.FullSearch.Elastic.IDocumentFullSearch" } ], "contentType": "domainService", "name": "ElasticDocumentFullSearch", "summary": null }, { "namespace": "Volo.Docs.Projects", "entityAnalyzeModel": { "namespace": "Volo.Docs.Projects", "primaryKeyType": "Guid", "properties": [], "contentType": "entity", "name": "Project", "summary": null }, "implementingInterfaces": [ { "name": "IBasicRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IBasicRepository" }, { "name": "IBasicRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IBasicRepository" }, { "name": "IReadOnlyBasicRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IReadOnlyBasicRepository" }, { "name": "IRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IRepository" }, { "name": "IReadOnlyBasicRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IReadOnlyBasicRepository" } ], "methods": [ { "returnType": "List", "namespace": "Volo.Docs.Projects", "name": "GetListAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "sorting", "isOptional": false }, { "type": "Int32", "name": "maxResultCount", "isOptional": false }, { "type": "Int32", "name": "skipCount", "isOptional": false }, { "type": "Boolean", "name": "includeDetails", "isOptional": true }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.Projects", "name": "GetListWithoutDetailsAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Project", "namespace": "Volo.Docs.Projects", "name": "GetByShortNameAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "shortName", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Boolean", "namespace": "Volo.Docs.Projects", "name": "ShortNameExistsAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "String", "name": "shortName", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] } ], "contentType": "repositoryInterface", "name": "IProjectRepository", "summary": null }, { "namespace": "Volo.Docs.Documents", "entityAnalyzeModel": { "namespace": "Volo.Docs.Documents", "primaryKeyType": "Guid", "properties": [], "contentType": "entity", "name": "Document", "summary": null }, "implementingInterfaces": [ { "name": "IBasicRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IBasicRepository" }, { "name": "IReadOnlyBasicRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IReadOnlyBasicRepository" }, { "name": "IRepository", "namespace": "Volo.Abp.Domain.Repositories", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Repositories.IRepository" } ], "methods": [ { "returnType": "List", "namespace": "Volo.Docs.Documents", "name": "GetListWithoutDetailsByProjectId", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.Documents", "name": "GetUniqueListDocumentInfoAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.Documents", "name": "GetListByProjectId", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.Documents", "name": "GetUniqueDocumentsByProjectIdPagedAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "Int32", "name": "skipCount", "isOptional": false }, { "type": "Int32", "name": "maxResultCount", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Int64", "namespace": "Volo.Docs.Documents", "name": "GetUniqueDocumentCountByProjectIdAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents", "name": "UpdateProjectLastCachedTimeAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "DateTime", "name": "cachedTime", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Document", "namespace": "Volo.Docs.Documents", "name": "FindAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "String", "name": "name", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "Boolean", "name": "includeDetails", "isOptional": true }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Document", "namespace": "Volo.Docs.Documents", "name": "FindAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "List", "name": "possibleNames", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "Boolean", "name": "includeDetails", "isOptional": true }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Void", "namespace": "Volo.Docs.Documents", "name": "DeleteAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "projectId", "isOptional": false }, { "type": "String", "name": "name", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "Boolean", "name": "autoSave", "isOptional": true }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.Documents", "name": "GetListAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Nullable", "name": "projectId", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "String", "name": "name", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "List", "namespace": "Volo.Docs.Documents", "name": "GetAllAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Nullable", "name": "projectId", "isOptional": false }, { "type": "String", "name": "name", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "fileName", "isOptional": false }, { "type": "String", "name": "format", "isOptional": false }, { "type": "Nullable", "name": "creationTimeMin", "isOptional": false }, { "type": "Nullable", "name": "creationTimeMax", "isOptional": false }, { "type": "Nullable", "name": "lastUpdatedTimeMin", "isOptional": false }, { "type": "Nullable", "name": "lastUpdatedTimeMax", "isOptional": false }, { "type": "Nullable", "name": "lastSignificantUpdateTimeMin", "isOptional": false }, { "type": "Nullable", "name": "lastSignificantUpdateTimeMax", "isOptional": false }, { "type": "Nullable", "name": "lastCachedTimeMin", "isOptional": false }, { "type": "Nullable", "name": "lastCachedTimeMax", "isOptional": false }, { "type": "String", "name": "sorting", "isOptional": true }, { "type": "Int32", "name": "maxResultCount", "isOptional": true }, { "type": "Int32", "name": "skipCount", "isOptional": true }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Int64", "namespace": "Volo.Docs.Documents", "name": "GetAllCountAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Nullable", "name": "projectId", "isOptional": false }, { "type": "String", "name": "name", "isOptional": false }, { "type": "String", "name": "version", "isOptional": false }, { "type": "String", "name": "languageCode", "isOptional": false }, { "type": "String", "name": "fileName", "isOptional": false }, { "type": "String", "name": "format", "isOptional": false }, { "type": "Nullable", "name": "creationTimeMin", "isOptional": false }, { "type": "Nullable", "name": "creationTimeMax", "isOptional": false }, { "type": "Nullable", "name": "lastUpdatedTimeMin", "isOptional": false }, { "type": "Nullable", "name": "lastUpdatedTimeMax", "isOptional": false }, { "type": "Nullable", "name": "lastSignificantUpdateTimeMin", "isOptional": false }, { "type": "Nullable", "name": "lastSignificantUpdateTimeMax", "isOptional": false }, { "type": "Nullable", "name": "lastCachedTimeMin", "isOptional": false }, { "type": "Nullable", "name": "lastCachedTimeMax", "isOptional": false }, { "type": "String", "name": "sorting", "isOptional": true }, { "type": "Int32", "name": "maxResultCount", "isOptional": true }, { "type": "Int32", "name": "skipCount", "isOptional": true }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] }, { "returnType": "Document", "namespace": "Volo.Docs.Documents", "name": "GetAsync", "summary": null, "isAsync": true, "isPublic": true, "isPrivate": false, "isStatic": false, "parameters": [ { "type": "Guid", "name": "id", "isOptional": false }, { "type": "CancellationToken", "name": "cancellationToken", "isOptional": true } ] } ], "contentType": "repositoryInterface", "name": "IDocumentRepository", "summary": null }, { "eventHandlerType": "Local", "namespace": "Volo.Docs.Documents.FullSearch.Elastic", "subscribedEvents": [ { "underlyingType": { "name": "Document", "namespace": "Volo.Docs.Documents", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Documents.Document" }, "name": "EntityCreatedEventData`1", "namespace": "Volo.Abp.Domain.Entities.Events", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.Events.EntityCreatedEventData`1" }, { "underlyingType": { "name": "Document", "namespace": "Volo.Docs.Documents", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Documents.Document" }, "name": "EntityUpdatedEventData`1", "namespace": "Volo.Abp.Domain.Entities.Events", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.Events.EntityUpdatedEventData`1" }, { "underlyingType": { "name": "Document", "namespace": "Volo.Docs.Documents", "declaringAssemblyName": "Volo.Docs.Domain", "fullName": "Volo.Docs.Documents.Document" }, "name": "EntityDeletedEventData`1", "namespace": "Volo.Abp.Domain.Entities.Events", "declaringAssemblyName": "Volo.Abp.Ddd.Domain", "fullName": "Volo.Abp.Domain.Entities.Events.EntityDeletedEventData`1" } ], "implementingInterfaces": [ { "name": "ILocalEventHandler", "namespace": "Volo.Abp.EventBus", "declaringAssemblyName": "Volo.Abp.EventBus.Abstractions", "fullName": "Volo.Abp.EventBus.ILocalEventHandler" }, { "name": "IEventHandler", "namespace": "Volo.Abp.EventBus", "declaringAssemblyName": "Volo.Abp.EventBus.Abstractions", "fullName": "Volo.Abp.EventBus.IEventHandler" }, { "name": "ILocalEventHandler", "namespace": "Volo.Abp.EventBus", "declaringAssemblyName": "Volo.Abp.EventBus.Abstractions", "fullName": "Volo.Abp.EventBus.ILocalEventHandler" }, { "name": "ILocalEventHandler", "namespace": "Volo.Abp.EventBus", "declaringAssemblyName": "Volo.Abp.EventBus.Abstractions", "fullName": "Volo.Abp.EventBus.ILocalEventHandler" }, { "name": "ITransientDependency", "namespace": "Volo.Abp.DependencyInjection", "declaringAssemblyName": "Volo.Abp.Core", "fullName": "Volo.Abp.DependencyInjection.ITransientDependency" } ], "contentType": "eventHandler", "name": "DocumentChangedEventHandler", "summary": null } ] }