1"use strict";(self.webpackChunkfluid_framework_website=self.webpackChunkfluid_framework_website||[]).push([[1396],{771972:(e,r,i)=>{i.r(r),i.d(r,{assets:()=>a,contentTitle:()=>d,default:()=>p,frontMatter:()=>o,metadata:()=>n,toc:()=>c});const n=JSON.parse('{"id":"api/odsp-driver-definitions/iodsperroraugmentations-interface","title":"IOdspErrorAugmentations Interface","description":"To use, import via @fluidframework/odsp-driver-definitions/legacy.","source":"@site/versioned_docs/version-2/api/odsp-driver-definitions/iodsperroraugmentations-interface.md","sourceDirName":"api/odsp-driver-definitions","slug":"/api/odsp-driver-definitions/iodsperroraugmentations-interface","permalink":"/docs/v2/api/odsp-driver-definitions/iodsperroraugmentations-interface","draft":false,"unlisted":false,"tags":[],"version":"2","frontMatter":{"title":"IOdspErrorAugmentations Interface","sidebar_label":"IOdspErrorAugmentations","displayed_sidebar":"docsSidebar"},"sidebar":"docsSidebar"}');var s=i(886070),t=i(403793);const o={title:"IOdspErrorAugmentations Interface",sidebar_label:"IOdspErrorAugmentations",displayed_sidebar:"docsSidebar"},d=void 0,a={},c=[{value:"Properties",id:"properties",level:2},{value:"Property Details",id:"property-details",level:2}];function l(e){const r={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",h4:"h4",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,t.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsxs)(r.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:[(0,s.jsxs)(r.p,{children:["To use, import via ",(0,s.jsx)(r.code,{children:"@fluidframework/odsp-driver-definitions/legacy"}),"."]}),(0,s.jsxs)(r.p,{children:["For more information about our API support guarantees, see ",(0,s.jsx)(r.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})]}),"\n",(0,s.jsx)(r.h2,{id:"iodsperroraugmentations-signature",children:"Signature"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"export interface IOdspErrorAugmentations\n"})}),"\n",(0,s.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n",(0,s.jsxs)(r.table,{children:[(0,s.jsx)(r.thead,{children:(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.th,{children:"Property"}),(0,s.jsx)(r.th,{children:"Alerts"}),(0,s.jsx)(r.th,{children:"Modifiers"}),(0,s.jsx)(r.th,{children:"Type"}),(0,s.jsx)(r.th,{children:"Description"})]})}),(0,s.jsxs)(r.tbody,{children:[(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.a,{href:"/docs/v2/api/odsp-driver-definitions/iodsperroraugmentations-interface#facetcodes-propertysignature",children:"facetCodes"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"Beta"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"optional"})}),(0,s.jsx)(r.td,{children:"string[]"}),(0,s.jsx)(r.td,{children:"It is array of error codes included in error response from server."})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.a,{href:"/docs/v2/api/odsp-driver-definitions/iodsperroraugmentations-interface#redirectlocation-propertysignature",children:"redirectLocation"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"Beta"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"optional"})}),(0,s.jsx)(r.td,{children:"string"}),(0,s.jsx)(r.td,{children:"It is the redirection url at which the network call should have been made. It is due to change in site domain of the file on server."})]}),(0,s.jsxs)(r.tr,{children:[(0,s.jsx)(r.td,{children:(0,s.jsx)(r.a,{href:"/docs/v2/api/odsp-driver-definitions/iodsperroraugmentations-interface#serverepoch-propertysignature",children:"serverEpoch"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"Beta"})}),(0,s.jsx)(r.td,{children:(0,s.jsx)(r.code,{children:"optional"})}),(0,s.jsx)(r.td,{children:"string"}),(0,s.jsx)(r.td,{children:"Server epoch indicates when the file was last modified. Used to detect modifications outside Fluid's services"})]})]})]}),"\n",(0,s.jsx)(r.h2,{id:"property-details",children:"Property Details"}),"\n",(0,s.jsx)(r.h3,{id:"facetcodes-propertysignature",children:"facetCodes"}),"\n",(0,s.jsx)(r.p,{children:"It is array of error codes included in error response from server."}),"\n",(0,s.jsx)(r.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,s.jsxs)(r.p,{children:["For more information about our API support guarantees, see ",(0,s.jsx)(r.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,s.jsx)(r.h4,{id:"facetcodes-signature",children:"Signature"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"facetCodes?: string[];\n"})}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"Type"}),": string[]"]}),"\n",(0,s.jsx)(r.h3,{id:"redirectlocation-propertysignature",children:"redirectLocation"}),"\n",(0,s.jsx)(r.p,{children:"It is the redirection url at which the network call should have been made. It is due to change in site domain of the file on server."}),"\n",(0,s.jsx)(r.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,s.jsxs)(r.p,{children:["For more information about our API support guarantees, see ",(0,s.jsx)(r.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,s.jsx)(r.h4,{id:"redirectlocation-signature",children:"Signature"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"redirectLocation?: string;\n"})}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"Type"}),": string"]}),"\n",(0,s.jsx)(r.h3,{id:"serverepoch-propertysignature",children:"serverEpoch"}),"\n",(0,s.jsx)(r.p,{children:"Server epoch indicates when the file was last modified. Used to detect modifications outside Fluid's services"}),"\n",(0,s.jsx)(r.admonition,{title:"This API is provided for existing users, but is not recommended for new users.",type:"warning",children:(0,s.jsxs)(r.p,{children:["For more information about our API support guarantees, see ",(0,s.jsx)(r.a,{href:"https://fluidframework.com/docs/build/releases-and-apitags/#api-support-levels",children:"here"}),"."]})}),"\n",(0,s.jsx)(r.h4,{id:"serverepoch-signature",children:"Signature"}),"\n",(0,s.jsx)(r.pre,{children:(0,s.jsx)(r.code,{className:"language-typescript",children:"serverEpoch?: string;\n"})}),"\n",(0,s.jsxs)(r.p,{children:[(0,s.jsx)(r.strong,{children:"Type"}),": string"]})]})}function p(e={}){const{wrapper:r}={...(0,t.R)(),...e.components};return r?(0,s.jsx)(r,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},403793:(e,r,i)=>{i.d(r,{R:()=>o,x:()=>d});var n=i(830758);const s={},t=n.createContext(s);function o(e){const r=n.useContext(t);return n.useMemo((function(){return"function"==typeof e?e(r):{...r,...e}}),[r,e])}function d(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:o(e.components),n.createElement(t.Provider,{value:r},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.