WikiRestClient class
VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf
- Extends
Oluşturucular
| Wiki |
Özellikler
| RESOURCE_AREA_ID |
Yöntemler
| add |
Wiki sayfasına yorum ekleyin. |
| add |
Wiki sayfası yorumuna bir tepki ekleyin. |
| create |
Wiki sayfasındaki bir yoruma ek yükler. |
| create |
Yeni bir sayfa görüntüleme istatistikleri kaynağı oluşturur veya mevcut bir sayfa görüntüleme istatistikleri kaynağını günceller. |
| create |
Wiki kaynağını oluşturur. |
| delete |
Wiki sayfasındaki bir yorumu silme. |
| delete |
Wiki sayfası yorumundaki bir tepkiyi silin. |
| delete |
Sağlanan viki kimliğine veya viki adına karşılık gelen wiki'yi siler. |
| get |
Bir proje veya koleksiyondaki tüm vikileri alır. |
| get |
Wiki sayfasındaki bir yorumda yer alan bir eki indirir. |
| get |
Wiki Sayfası ile ilişkilendirilmiş bir açıklama döndürür. |
| get |
Belirli bir tepki türüyle verilen viki yorumu için tepki veren kullanıcıların bir listesini alır. Varsayılan sayfa boyutu aynı anda 100 kullanıcı olacak şekilde sayfalamayı destekler. |
| get |
Sağlanan sayfa kimliği için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre |
| get |
Sağlanan sayfa kimliği için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre |
| get |
Sayfa Kimliği'ne karşılık gelen sayfa ayrıntısını döndürür. |
| get |
Wiki Sayfalarının sayfalanabilir listesini döndürür |
| get |
Sağlanan yol için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre |
| get |
Sağlanan yol için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre |
| get |
Sağlanan viki kimliğine veya viki adına karşılık gelen wiki'yi alır. |
| list |
Sayfalanabilir bir yorum listesi döndürür. |
| update |
Wiki sayfasındaki bir yorumu güncelleştirin. |
| update |
Güncelleme parametreleri kullanılarak sağlanan wiki kimliğine veya wiki adına karşılık gelen wiki'yi günceller. |
Oluşturucu Ayrıntıları
WikiRestClient(IVssRestClientOptions)
Özellik Ayrıntıları
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringÖzellik Değeri
string
Yöntem Ayrıntıları
addComment(CommentCreateParameters, string, string, number)
Wiki sayfasına yorum ekleyin.
function addComment(request: CommentCreateParameters, project: string, wikiIdentifier: string, pageId: number): Promise<Comment>Parametreler
- request
- CommentCreateParameters
Yorum oluşturma isteği.
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
Döndürülenler
Promise<Comment>
addCommentReaction(string, string, number, number, CommentReactionType)
Wiki sayfası yorumuna bir tepki ekleyin.
function addCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı
- pageId
-
number
Wiki sayfası kimliği
- commentId
-
number
İlişkili yorumun kimliği
- type
- CommentReactionType
Eklenen reaksiyonun türü
Döndürülenler
Promise<CommentReaction>
createCommentAttachment(any, string, string, number)
Wiki sayfasındaki bir yoruma ek yükler.
function createCommentAttachment(content: any, project: string, wikiIdentifier: string, pageId: number): Promise<CommentAttachment>Parametreler
- content
-
any
Karşıya yüklenecek içerik
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
Döndürülenler
Promise<CommentAttachment>
createOrUpdatePageViewStats(string, string, GitVersionDescriptor, string, string)
Yeni bir sayfa görüntüleme istatistikleri kaynağı oluşturur veya mevcut bir sayfa görüntüleme istatistikleri kaynağını günceller.
function createOrUpdatePageViewStats(project: string, wikiIdentifier: string, wikiVersion: GitVersionDescriptor, path: string, oldPath?: string): Promise<WikiPageViewStats>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- wikiVersion
- GitVersionDescriptor
Wiki sürümü.
- path
-
string
Wiki sayfası yolu.
- oldPath
-
string
Eski sayfa yolu. Bu isteğe bağlıdır ve mevcut sayfa görüntüleme istatistiklerinde yolu yeniden adlandırmak için gereklidir.
Döndürülenler
Promise<WikiPageViewStats>
createWiki(WikiCreateParametersV2, string)
Wiki kaynağını oluşturur.
function createWiki(wikiCreateParams: WikiCreateParametersV2, project?: string): Promise<WikiV2>Parametreler
- wikiCreateParams
- WikiCreateParametersV2
Wiki oluşturma parametreleri.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<WikiV2>
deleteComment(string, string, number, number)
Wiki sayfasındaki bir yorumu silme.
function deleteComment(project: string, wikiIdentifier: string, pageId: number, id: number): Promise<void>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Viki Kimliği veya adı.
- pageId
-
number
Wiki sayfası kimliği.
- id
-
number
Yorum Kimliği.
Döndürülenler
Promise<void>
deleteCommentReaction(string, string, number, number, CommentReactionType)
Wiki sayfası yorumundaki bir tepkiyi silin.
function deleteCommentReaction(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType): Promise<CommentReaction>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Viki Kimliği veya adı
- pageId
-
number
Wiki sayfası kimliği
- commentId
-
number
İlişkili yorumun kimliği
- type
- CommentReactionType
Silinmekte olan reaksiyonun türü
Döndürülenler
Promise<CommentReaction>
deleteWiki(string, string)
Sağlanan viki kimliğine veya viki adına karşılık gelen wiki'yi siler.
function deleteWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametreler
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<WikiV2>
getAllWikis(string)
Bir proje veya koleksiyondaki tüm vikileri alır.
function getAllWikis(project?: string): Promise<WikiV2[]>Parametreler
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<WikiV2[]>
getAttachmentContent(string, string, number, string)
Wiki sayfasındaki bir yorumda yer alan bir eki indirir.
function getAttachmentContent(project: string, wikiIdentifier: string, pageId: number, attachmentId: string): Promise<ArrayBuffer>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
- attachmentId
-
string
Ek Kimliği.
Döndürülenler
Promise<ArrayBuffer>
getComment(string, string, number, number, boolean, CommentExpandOptions)
Wiki Sayfası ile ilişkilendirilmiş bir açıklama döndürür.
function getComment(project: string, wikiIdentifier: string, pageId: number, id: number, excludeDeleted?: boolean, expand?: CommentExpandOptions): Promise<Comment>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
- id
-
number
Döndürülecek yorumun kimliği.
- excludeDeleted
-
boolean
Silinen yorumun atlanıp atlanmayacağını belirtin.
- expand
- CommentExpandOptions
Yorumlar için ek veri alma seçeneklerini belirtir.
Döndürülenler
Promise<Comment>
getEngagedUsers(string, string, number, number, CommentReactionType, number, number)
Belirli bir tepki türüyle verilen viki yorumu için tepki veren kullanıcıların bir listesini alır. Varsayılan sayfa boyutu aynı anda 100 kullanıcı olacak şekilde sayfalamayı destekler.
function getEngagedUsers(project: string, wikiIdentifier: string, pageId: number, commentId: number, type: CommentReactionType, top?: number, skip?: number): Promise<IdentityRef[]>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
- commentId
-
number
İlişkili yorumun kimliği
- type
- CommentReactionType
İlgili kullanıcılardan talep edilen tepkinin türü
- top
-
number
Belirli bir sayfada döndürülecek birleştirilmiş kullanıcı sayısı. İsteğe bağlı, varsayılan değer 100'dür
- skip
-
number
Bir sonraki ilgili kullanıcı kümesinin sayfasına atlanacak ilgili kullanıcı sayısı, varsayılan olarak 0'dır
Döndürülenler
Promise<IdentityRef[]>
getPageByIdText(string, string, number, VersionControlRecursionType, boolean)
Sağlanan sayfa kimliği için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre Accept yapılır.
function getPageByIdText(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<string>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Viki Kimliği veya viki adı..
- id
-
number
Wiki sayfası kimliği.
- recursionLevel
- VersionControlRecursionType
Alt sayfaların alınması için özyineleme düzeyi. Varsayılan olarak (İsteğe bağlı) şeklindedir None .
- includeContent
-
boolean
Sayfanın içeriğini Json içerik türü yanıtına dahil etmek için True. Varsayılan olarak false (İsteğe bağlı)
Döndürülenler
Promise<string>
getPageByIdZip(string, string, number, VersionControlRecursionType, boolean)
Sağlanan sayfa kimliği için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre Accept yapılır.
function getPageByIdZip(project: string, wikiIdentifier: string, id: number, recursionLevel?: VersionControlRecursionType, includeContent?: boolean): Promise<ArrayBuffer>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Viki Kimliği veya viki adı..
- id
-
number
Wiki sayfası kimliği.
- recursionLevel
- VersionControlRecursionType
Alt sayfaların alınması için özyineleme düzeyi. Varsayılan olarak (İsteğe bağlı) şeklindedir None .
- includeContent
-
boolean
Sayfanın içeriğini Json içerik türü yanıtına dahil etmek için True. Varsayılan olarak false (İsteğe bağlı)
Döndürülenler
Promise<ArrayBuffer>
getPageData(string, string, number, number)
Sayfa Kimliği'ne karşılık gelen sayfa ayrıntısını döndürür.
function getPageData(project: string, wikiIdentifier: string, pageId: number, pageViewsForDays?: number): Promise<WikiPageDetail>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
- pageViewsForDays
-
number
Sayfa görüntülemelerinin döndürüleceği geçerli günden itibaren son N gün. Şimdiki günü de kapsıyor.
Döndürülenler
Promise<WikiPageDetail>
getPagesBatch(WikiPagesBatchRequest, string, string, GitVersionDescriptor)
Wiki Sayfalarının sayfalanabilir listesini döndürür
function getPagesBatch(pagesBatchRequest: WikiPagesBatchRequest, project: string, wikiIdentifier: string, versionDescriptor?: GitVersionDescriptor): Promise<PagedList<WikiPageDetail>>Parametreler
- pagesBatchRequest
- WikiPagesBatchRequest
Wiki toplu sayfa isteği.
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- versionDescriptor
- GitVersionDescriptor
Sayfa için GitVersionDescriptor. (ProjectWiki durumunda isteğe bağlıdır).
Döndürülenler
Promise<PagedList<WikiPageDetail>>
getPageText(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Sağlanan yol için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre Accept yapılır.
function getPageText(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<string>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- path
-
string
Wiki sayfası yolu.
- recursionLevel
- VersionControlRecursionType
Alt sayfaların alınması için özyineleme düzeyi. Varsayılan olarak (İsteğe bağlı) şeklindedir None .
- versionDescriptor
- GitVersionDescriptor
Sayfa için GitVersionDescriptor. Varsayılan olarak varsayılan daldır (İsteğe bağlı).
- includeContent
-
boolean
Sayfanın içeriğini Json içerik türü yanıtına dahil etmek için True. Varsayılan olarak false (İsteğe bağlı)
Döndürülenler
Promise<string>
getPageZip(string, string, string, VersionControlRecursionType, GitVersionDescriptor, boolean)
Sağlanan yol için wiki sayfasının meta verilerini veya içeriğini alır. İçerik müzakeresi, istekte gönderilen başlığa göre Accept yapılır.
function getPageZip(project: string, wikiIdentifier: string, path?: string, recursionLevel?: VersionControlRecursionType, versionDescriptor?: GitVersionDescriptor, includeContent?: boolean): Promise<ArrayBuffer>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- path
-
string
Wiki sayfası yolu.
- recursionLevel
- VersionControlRecursionType
Alt sayfaların alınması için özyineleme düzeyi. Varsayılan olarak (İsteğe bağlı) şeklindedir None .
- versionDescriptor
- GitVersionDescriptor
Sayfa için GitVersionDescriptor. Varsayılan olarak varsayılan daldır (İsteğe bağlı).
- includeContent
-
boolean
Sayfanın içeriğini Json içerik türü yanıtına dahil etmek için True. Varsayılan olarak false (İsteğe bağlı)
Döndürülenler
Promise<ArrayBuffer>
getWiki(string, string)
Sağlanan viki kimliğine veya viki adına karşılık gelen wiki'yi alır.
function getWiki(wikiIdentifier: string, project?: string): Promise<WikiV2>Parametreler
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<WikiV2>
listComments(string, string, number, number, string, boolean, CommentExpandOptions, CommentSortOrder, number)
Sayfalanabilir bir yorum listesi döndürür.
function listComments(project: string, wikiIdentifier: string, pageId: number, top?: number, continuationToken?: string, excludeDeleted?: boolean, expand?: CommentExpandOptions, order?: CommentSortOrder, parentId?: number): Promise<CommentList>Parametreler
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
- top
-
number
Döndürülecek maksimum yorum sayısı.
- continuationToken
-
string
Sonraki yorum sayfasını sorgulamak için kullanılır.
- excludeDeleted
-
boolean
Silinen yorumların atlanıp atlanmayacağını belirtin.
- expand
- CommentExpandOptions
Yorumlar için ek veri alma seçeneklerini belirtir.
- order
- CommentSortOrder
Yorumların döndürülmesi gereken sıra.
- parentId
-
number
Üst yorumun CommentId'si.
Döndürülenler
Promise<CommentList>
updateComment(CommentUpdateParameters, string, string, number, number)
Wiki sayfasındaki bir yorumu güncelleştirin.
function updateComment(comment: CommentUpdateParameters, project: string, wikiIdentifier: string, pageId: number, id: number): Promise<Comment>Parametreler
- comment
- CommentUpdateParameters
Yorum güncelleme isteği.
- project
-
string
Proje kimliği veya proje adı
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- pageId
-
number
Wiki sayfası kimliği.
- id
-
number
Yorum Kimliği.
Döndürülenler
Promise<Comment>
updateWiki(WikiUpdateParameters, string, string)
Güncelleme parametreleri kullanılarak sağlanan wiki kimliğine veya wiki adına karşılık gelen wiki'yi günceller.
function updateWiki(updateParameters: WikiUpdateParameters, wikiIdentifier: string, project?: string): Promise<WikiV2>Parametreler
- updateParameters
- WikiUpdateParameters
Parametreleri güncelleştirin.
- wikiIdentifier
-
string
Wiki Kimliği veya wiki adı.
- project
-
string
Proje kimliği veya proje adı
Döndürülenler
Promise<WikiV2>